Gradle 构建java 项目详解

不念不忘少年蓝@ 2022-03-06 14:24 505阅读 0赞

#### gradle 概念 ####

gradle 在构建项目中有两个重要的概念分别是project与task；  
每个 project 都由多个 tasks 组成；每个 task 都代表了构建执行过程中的一个具体操作任务；  
当我们从终端执行gradle命令时，gradle 命令会从当前目录下寻找 build.gradle 文件来执行构建。build.gradle 就是构建脚本；一个build.gradle 可以包含多个project。

#### java 项目是如何使用gradle中插件以及语法呢？ ####

plugins{
        id "java"
        id "org.springframework.boot" version "2.0.4.RELEASE" apply false
        ...
    }
    apply plugin: 'java'
    apply plugin: 'org.springframework.boot'

**我们在项目中往往会看到这样写法，这样写的作用是什么呢？**

*  gradle核心插件中的插件可以不适用版本号，gradle社区插件必须包含版本号规范。使用java插件只要通过id引用就可以了，而springboot插件则需要使用版本号；
 *  plugins\{\}相当于一个插件管理器，可以直接引入插件也可以只引入这个插件的声明；
    
     *  id ‘java’ 就是将java的一些构建任务tasks引入进来，项目在打包编译的时，会执行java插件中任务，我们可以通过gradle tasks --all 密令查看java插件的任务；
     *  ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoYW5nZTk4NzY1NDMyMQ_size_16_color_FFFFFF_t_70]
     *  id ‘org.springframework.boot’ version ‘2.0.4.RELEASE’ apply false; 使用apply属性为false 表示当前插件只是在这里声明，并没有引入SpringBoot的相关配置任务；
 *  通过apply plugin 引用插件
    
     *  其中apply plugin: ‘java’ 与plugins中id ‘java’ 使用效果是一样的，java数据gradle核心插件，不需要版本声明；
     *  apply plugin: ‘org.springframework.boot’ 就是真正将plugins\{\}中声明的springboot插件引入到构建脚本中；  
        还有很多核心插件，向官网查看；  
        如何我们不想在每个项目的build.gradle中声明apply plugin插件，我们改如何统一管理呢？

**核心插件subprojects与allprojects的区别**

allprojects {
        apply plugin: 'idea'
        // 配置maven 仓库,也可以配置自己的私服
        repositories {
           mavenCentral()
           maven {
                url :'自己私服地址'
           }
        }
        // 全局统一jar的版本号
        ext {  
            rxjavaVersion        = "1.3.8"
    	     rxjavaAdapterVersion = "1.2.1"
    	     rxjava2Version       = "2.2.5"
        }
    }
    subprojects{
        apply plugin: 'java'
        apply plugin: 'maven'
        // JVM 版本号
        sourceCompatibility = 1.8
        targetCompatibility = 1.8
        // java 编译时编码设置
        [compileJava,compileTestJava,javadoc]*.options*.encoding = 'UTF-8'
        // 项目依赖的jar包
        dependencies {
            testCompile 'junit:junit:4.12'
        }
    }

*  ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoYW5nZTk4NzY1NDMyMQ_size_16_color_FFFFFF_t_70 1]
 *  allprojects\{\} 配置整个项目公用的属性与插件，其中包括project api
 *  subprojects\{\} 配置的是子模块的公用属性与插件；
 *  我们在父项目执行gradle tasks --all 只能查看idea的一些任务，而在kc-model 中执行密令可以看到idea，java，maven三种插件中所有的任务；

**dependencies 依赖使用详解**

dependencies{
            api project(':mylibrary')
            implementation 'org.springframework:spring-web:5.0.3.BUILD-SNAPSHOT'
            compile('org.springframework.boot:spring-boot-starter-amqp')
            runtimeOnly('mysql:mysql-connector-java:5.1.46')
            testImplementation group: 'junit', name: 'junit', version: '4.12'
    }
    还可以定义configurations{},然后在dependencies中使用定义好的名称；

*  implementation：将依赖项添加到项目中，并在构建时将依赖项打包进项目；但是依赖进来的项目不可以传递依赖；
    
     *  implementation 三种使用方式：
     *  implementation project(":mylibrary") 依赖本地项目
     *  implementation fileTree(dir: ‘libs’, include: \[’\*.jar’\]) 依赖lib包
     *  implementation ‘com.example.android:app-magic:12.3’ 依赖远程项目
 *  api:可以将依赖项编译打包进项目，可以进行模块之间的传递依赖；api只有java-library 插件中才有的属性；
 *  compileOnly：Gradle 仅将依赖项添加到编译类中，不会添加到构建输出项目中。取代了runtime
 *  compile：implementation与api 是用来替换compile的，compile拥有两者的功能,已经被Gradle废弃；
 *  testImplementation：测试依赖，构建时不打入包中，去掉了testCompile

**当我们的项目依赖存在冲突时，如何排查jar冲突呢？**

*  在控制台输入：gradle dependencies --configuration default 查看当前项目jar依赖树；
 *  查看子模块dependencies 依赖树：gradle dependencies mymodel:dependencies --configuration default;将mymodel 替换成自己的项目名称，查看子模块依赖结果树，进行冲突排查；查看到冲突之后我们如何处理呢？

dependencies {
        implementation(group: 'com.alibaba', name: 'dubbo', version: '2.6.5') {
            //当项目有多个dubbo包依赖时，我们可以在父项目强制统一版本号为2.6.5:
            force = true
            //排除包所有的spring-core 模块
            exclude module: 'spring-core'
            //排除指定的单个模块，排除springframework中的spring-beans
            exclude group: 'org.springframework',module:'spring-beans'
            //排除springframework整个包
            exclude group: 'org.springframework'
            //禁止传递依赖，dubbo依赖的其他包都不能传递依赖
            transitive = false
        }
        testCompile group: 'junit', name: 'junit', version: '4.12'
    }

**gradle 常用构建密令**

*  gradle clean: 删除 build 目录以及所有构建完成的文件。
 *  gradle build: 构建并打包项目
 *  gradle check:编译并测试代码。一些其他插件也可能会增强这个任务的功能。例如，如果采用了 Code-quality 插件，这个任务会额外执行 Checkstyle。
 *  gradle assemble: 编译并打包 jar 文件，但不会执行单元测试。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoYW5nZTk4NzY1NDMyMQ_size_16_color_FFFFFF_t_70]: /images/20220303/25d35462c1774f9792ab4007c4472093.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoYW5nZTk4NzY1NDMyMQ_size_16_color_FFFFFF_t_70 1]: /images/20220303/923ff0fd8fbe46cc870f31509441e26e.png