Android学习笔记第1章 Android应用和开发环境 1.2 使用Gradle自动化构建项目 1.2.5 Gradle插件和Java、application等插件

今天药忘吃喽~ 2024-03-26 15:13 54阅读 0赞

#### Android学习笔记 ####

#### 文章目录 ####

*   *   *  Android学习笔记
         *  第1章 Android应用和开发环境
         *   *  1.2 使用Gradle自动化构建项目
             *   *  1.2.5 Gradle插件和Java、application等插件

> 疯狂Android讲义

#### 第1章 Android应用和开发环境 ####

##### 1.2 使用Gradle自动化构建项目 #####

###### 1.2.5 Gradle插件和Java、application等插件 ######

为了简化开发人员编写构建文件的工作，Gradle提供了插件机制。

开发Gradle插件很简单，无非就是在插件中预先定义大量的任务类型、任务、属性等，接下来开发人员只要在build.gradle文件中使用如下代码来应用插件即可。

apply plugin: 插件名

应用插件就相当于引入了该插件包含的所有任务类型、任务和属性等，这样Gradle即可执行插件中预先定义好的任务。

前面在介绍JavaCompile、JavaExec类型的任务时使用过java插件，引用该插件之后，不仅引入了这两种任务类型，还增加了大量任务。

比如在build…gradle文件中仅增加如下代码：

apply plugin: 'java'

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

执行如下命令查看该构建文件中支持的所有任务

gradle tasks --all

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

可以看到，增加了如下任务：

*  assemble:装配整个项目。
 *  build:装配并测试该项目。
 *  buildDependents:.装配并测试该项目，以及该项目的依赖项目。
 *  buildNeeded:与buildDependents任务基本相同。
 *  classes:装配该项目的所有类。
 *  clean:删除构建目录的所有内容。属于Delete类型的任务。
 *  jar:将项目的所有类打包成JAR包。属于Jar类型的任务。
 *  testClasses:装配所有测试类。
 *  init:执行构建的初始化操作。
 *  wrapper:生成Gradle包装文件。
 *  javadoc:为所有类生成API文档。属于Javadoc类型的任务。
 *  compileJava:编译项目的所有主Java源文件。属于JavaCompile类型的任务。
 *  compileTestJava:编译项目的所有测试Java源文件。属于JavaCompile类型的任务。
 *  processResources:处理该项目的所有主资源。属于Copy类型的任务。
 *  processTestResources:处理该项目的所有测试资源。属于Copy类型的任务。

此外，java插件还定义了大量属性，比如sourceCompatibility属性用于指定在编译Java源文件时所使用的JDK版本；archivesBaseName属性用于指定打包成JAR包时的文件名。

在默认情况下，java插件要求将项目源代码和资源都放在src目录下，将构建生成的字节码文件和资源放在build目录下，该插件会自动管理该目录下的两类源代码和资源。

*  main:项目的主代码和资源。
 *  test:项目的测试代码和资源。

main和test目录都可包含java和resources两个子目录，其中java子目录存放Java源文件；resources子目录存放资源文件。

可以看出，main和test目录的内容基本相同，区别只是main目录存放项目的主代码和资源；而test目录存放项目的测试代码和资源。

> 我们可以在构建文件中通过sourceSets方法来改变项目主代码、资源的存储路径、测试代码和资源的存储路径

此外，如果项目需要添加第三方或额外依赖的源代码，则可通过sourceSets方法进行配置。

为了配置第三方或额外依赖的源代码路径，需要使用sourceSets方法，代码如下。

先准备一个源代码路径

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

编写配置文件

// 配置被依赖的源代码路径
    sourceSets{
        
        dingjiaxiongframework
    }

此时可以将dingjiaxiongframework的Java源代码放在src/dingjiaxiongframework/java目录下，将该框架的资源文件放在src/dingjiaxiongframework/resources目录下。

Gradle会自动为每一个新创建的sourceSet创建相应的Task,创建规律为：对于名为  
“dingjiaxiongframework”的sourceSet,.Gradle将为其创建compileDingjiaxiongframeworkJava、processDingjiaxiongframework-Resources和dingjiaxiongframeworkClasses这3个Task,它们的作用分别类似于compileJava、processResources和classes一区别只是前面3个Task处理fkframework目录下的Java源代码和资源，而后面3个Task处理main目录下的Java源代码和资源。

> 【注意】
> 
> 对于main而言，Gradle生成的3个任务并不是compileMainJava、processMainResources和mainClasses,这是由于main是Gradle默认创建的主sourceSet,因此main对应的3个任务就不需要“main”名称了。

通常来说，主项目的源代码和测试代码往往需要依赖第三方项目源代码，因此还需要进行如下配置。

①保证Gradle先编译第三方项目源代码，再编译主项目源代码。因此，需要在构建文件中配置如下依赖。

// 配置compileJava任务依赖compileDingjiaxiongframeworkJava任务
    compileJava.dependsOn compileDingjiaxiongframeworkJava

②将第三方项目的字节码文件的存储路径添加到系统编译时、运行时的类路径中。因此，需要在构建文件中进行如下配置。

sourceSets{
        
        main{
        
            // 将dingjiaxiongframework生成的字节码文件的存储路径添加到编译时的类路径中
            compileClasspath = compileClasspath + files(dingjiaxiongframework.output.classesDir)
        }
    
        test{
        
            // 将dingjiaxiongframework生成的字节码文件的存储路径添加到运行时的类路径中
            runtimeClasspath = runtimeClasspath + files(dingjiaxiongframework.output.classesDir)
        }
    }

经过上面配置，Gradle即可将src目录下的dingjiaxiongframework下第三方框架纳入构建过程中，gradle在项目构建过程中会先编译第三方项目依赖的框架，再构建主项目。

让main目录下的Java类引用fkframework下的某个Java类，

package dingjiaxiong;
    import org.dingjiaxiong.User;
    
    public class HelloWorld{
        
        public static void main(String[] args) {
        
            System.out.println(new User());
        }
    }

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

接下来可通过gradle build命令来构建项目，此时将会看到项目构建成功。

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

Gradle还提供了一个application插件，该插件主要增加了一个mainClassName属性和run、startScripts等任务，其中mainClassName属性用于指定该项目的主类，而run任务则用于运行主类。

在build.gradle文件中增加如下配置：

apply plugin: 'application'
    
    // 指定run任务执行的主类
    mainClassName = 'dingjiaxiong.HelloWorld'
    
    //为run任务的classpath增加dingjiaxiongframework的类【由于dingjiaxiongframework是我们自己添加的sourceSet，run任务默认不会加载该sourceSet的类】
    run.classpath = sourceSets.main.runtimeClasspath + files(sourceSets.dingjiaxiongframework.output.classesDir)

【完整配置文件】

apply plugin: 'java'
    apply plugin: 'application'
    
    // 指定run任务执行的主类
    mainClassName = 'dingjiaxiong.HelloWorld'
    
    // 配置被依赖的源代码路径
    sourceSets{
        
        dingjiaxiongframework
    }
    
    //为run任务的classpath增加dingjiaxiongframework的类
    run.classpath = sourceSets.main.runtimeClasspath + files(sourceSets.dingjiaxiongframework.output.classesDir)
    
    // 配置compileJava任务依赖compileDingjiaxiongframeworkJava任务
    compileJava.dependsOn compileDingjiaxiongframeworkJava
    
    sourceSets{
        
        main{
        
            // 将dingjiaxiongframework生成的字节码文件的存储路径添加到编译时的类路径中
            compileClasspath = compileClasspath + files(dingjiaxiongframework.output.classesDir)
        }
    
        test{
        
            // 将dingjiaxiongframework生成的字节码文件的存储路径添加到运行时的类路径中
            runtimeClasspath = runtimeClasspath + files(dingjiaxiongframework.output.classesDir)
        }
    }

接下来可以通过gradle run命令来执行run任务，这样即可运行dingjiaxiong.HelloWorld类。

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

牛逼66666。

[c685c2fac98a4519aecc4557c5f5b416.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/cd06ff211a3246a5b3c75f6f16fd82a6.png
[9621e8c451964a42ac77d0041fa055e0.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/0c8f1639959d45f2b658e5c824422b25.png
[794f5460b8ba41a3b622dee95f16557a.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/938909db48c44477bd31b97968fc94b0.png
[07bdafea6c364de3bb0804af9879f89f.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/7d13696a30c74153bcfd464a2a7e77bd.png
[c036a5f4290b48aab09fd4f33acda1a0.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/9406a2e07d62450384cc2a3692dc6504.png
[2c3b0f35252448709889499a46599569.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/2b8a014f5ee841cdb12f4b5ba1f1d6b5.png