Skip to content

Gradle

Jump to bottom
kcp edited this page Oct 13, 2020 · 3 revisions

title: Gradle date: 2018-12-12 21:29:59 tags: - Gradle categories: - Java

目录 start

  1. Gradle
    1. 书籍
    2. 发行版本列表
  2. 安装
    1. Chocolate
    2. Docker安装
    3. 手动配置
    4. Wrapper
    5. CUI使用
      1. 命令行选项
      2. 动作
        1. build
        2. test
      3. 守护进程
  3. 配置
    1. 全局配置文件
    2. build.gradle
      1. SourceSet
      2. 依赖管理
        1. 依赖排除以及指定依赖版本
        2. 统一管理依赖
      3. 配置镜像源
      4. 插件
        1. Lombok
        2. Maven Publish
        3. shadowJar
        4. docker
        5. protobuf-gradle-plugin
    3. setting.gradle
  4. Gradle多模块的构建
    1. 另一种多模块的构建方式
  5. 使用
    1. 安装到本地仓库
    2. 上传至构件仓库
  6. 打包部署
    1. 构建Docker镜像
      1. 插件方式构建Docker镜像

目录 end|2020-10-13 11:11|

Gradle

Official Guide | tutorials

参考: 零散知识点总结(1) - Gradle 使用配置总结

Github: Gradle samples

优缺点

Gradle大吐槽 官方对比Gradle和Maven

优点

  1. 相对于Maven, 配置文件简洁了很多, 所以才入坑学习使用的
  2. 对于一些需要自定义的任务,因为核心为Groovy,所以实现能力高
    • 例如:将一个SpringBoot项目构建成一个镜像,并tag上当前构建的镜像为release,然后删除旧有容器,使用新的镜像启动容器

缺点

  1. 内存占用巨大,存在内存泄露问题, 以至于在IDEA上不敢使用自动导入, 不然每动一下build.gradle 就会卡半天, 8G内存都不够用!!
  2. 编译速度慢, 如果和Maven进行对比, 编译速度和资源占用确实慢

个人看法

参考: Gradle在大型Java项目上的应用

书籍

Gradle in Action 中译 如果没有一点Groovy基础, 阅读自定义Task等一些高自定义的地方还是比较困惑

发行版本列表

Github地址查看简洁的 Release Note 更方便

安装

注意 Gradle 会默认使用Maven的本地库, 但是是复制过来使用而不是共用
会将 ~/.m2/repository 复制到 ~/.gradle/caches/modules-2/files-2.1/, 目录结构也发生改变

或者 SDKMAN安装 sdk install gradle

Chocolate

  • windows 上安装 chocolate
  • PowerShell中运行 wr https://chocolatey.org/install.ps1 -UseBasicParsing | iex
  • 若操作系统默认禁止执行脚本，执行一次set-executionpolicy remotesigned后脚本顺利执行
  • Chocolatey在安装包的时候，默认路径是按照系统的默认路径来的，如果想修改安装路径可以这样处理：
  1. 执行“开始/运行”命令（或者WIN + R），输入“regedit”，打开注册表。
  2. 展开注册表到下面的分支[HKEY＿LOCAL＿MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion]，在右侧窗口中找到名为“ProgramFilesDir”的字符串，双击把数值“C:\Program Files”修改为“D：\ProgramFiles”，确定退出后,即可更改常用软件的安装路径了。

Docker安装

Docker 文档 虽然在开发时感觉意义不大, 还要把项目映射进去..

手动配置

官方下载网址 有各个版本的下载以及版本发行说明

  1. 解压到任意目录, 并将 bin 目录加入 环境变量即可

Wrapper

The Gradle Wrapper

类似于 Maven 的 mvnw 脚本 在使用IDE生成项目的时候，可以选择gradle的执行目录，可以选gradle wrapper 也可以选自己下载解压的完整包
如果使用的不是这个wrapper，那么别人在下载项目后，运行gradle命令就要先安装gradle，使用wrapper更好

   task wrapper(type: Wrapper){
      gradleVersion = '4.8'
      distributionUrl = '限定访问内网的URL'
      distributionPath = '包装器被解压缩放的相对路径'
   }
  • 运行 gradle wrapper 一次即可开始使用包装器的脚本来构建项目了
  • 生成gradle包管理器：gradle wrapper --gradle-version 2.0

CUI使用

命令行选项

  • tasks : 输出所有建立的task

  • properties : 输出所有可用的配置属性

  • 执行 task gradle taskName

  • 交互式新建项目 gradle init

  • -b，--build-file test.gradle 指定运行脚本文件

  • --offline 离线模式

  • -P ,--project-prop:配置参数 -Pmyprop=value

  • -i,--info : 打印info级别的输出

  • -s,--stacktrace: 输出错误栈

  • -q,--quiet:减少构建出错时打印的错误信息

动作

build

test

  • gradle test -Dtest.single=YourTestClass
  • gradle test --tests org.somewhere.MyTestClass
  • gradle test --tests org.somewhere.MyTestClass.my_test_case

守护进程

  • 命令加上 --daemon就会开启一个守护进程，只会开启一次
  • 守护进程会在空闲3小时后销毁
  • 手动关闭 gadle --stop
  • 构建时不采用守护进程 --no--daemon

配置

全局配置文件

~/.gradle/init.gradle

    allprojects{
        repositories {
            def ALIYUN_REPOSITORY_URL = 'https://maven.aliyun.com/nexus/content/groups/public'
            def ALIYUN_JCENTER_URL = 'https://maven.aliyun.com/nexus/content/repositories/jcenter'
            all { 
                ArtifactRepository repo ->
                if(repo instanceof MavenArtifactRepository){
                    def url = repo.url.toString()
                    if (url.startsWith('https://repo1.maven.org/maven2')) {
                        project.logger.lifecycle "Repository ${repo.url} replaced by $ALIYUN_REPOSITORY_URL."
                        remove repo
                    }
                    if (url.startsWith('https://jcenter.bintray.com/')) {
                        project.logger.lifecycle "Repository ${repo.url} replaced by $ALIYUN_JCENTER_URL."
                        remove repo
                    }
                }
            }
            maven {
                url ALIYUN_REPOSITORY_URL
                url ALIYUN_JCENTER_URL
            }
        }
    }

build.gradle

Hello World

   task helloworld{
      doLast {
         printf 'Hello World!'
      }
   }
   // 或者是 使用 << 代表doLast：
   task helloworld<<{
      println 'Hello world!'
   }

运行：gradle -q helloworld

初始化新项目 Doc:building java application 或者直接使用 gradle init 交互式新建一个项目

SourceSet

SourceSet

    sourceSets{
        main{
            proto{
                srcDir 'proto/proto'
            }
            java{
                srcDir 'out/build/generated/main'
            }
        }
    }

依赖管理

和Maven用的是同一种方式: groupId artifactId version

注意: Java项目中 compile 在 Gradle 已弃用, 取而代之的是新增的多种定义方式 implementation api 等等
明确了各种定义方式在项目中依赖的范围, 看起来更完美, 但是复杂度大大提高了

所以依据个人使用爱好, 简单易用就 compile testCompile 到底, 强迫症就 好好看官方文档 所有定义方式过一遍....

在定义项目时

  • 可以直接使用简单原始的 Java plugin

  • 也可以根据使用场景的不同使用不同的方案 Building Java & JVM projects

    1. Java libraries 适用于: Java 库.
    2. Java applications 适用于: 可执行jar
    3. Java web applications 适用于: Java Web项目, 打包成 war
    4. Java EE applications 适用于: Java EE, 打包成 ear
    5. Java Platforms 适用于: Java套件, 本身不包含任何代码, 只是一组依赖的聚合

Java

implementation
Gradle 中取代 compile 的方式, 使用范围比 compile 略小, 比如

  • B 项目中定义依赖: implementation A
  • C 项目中定义依赖: implementation B

此时 C 项目不能在代码中使用 A 中的类, 因为在 C 项目中 A 是声明为 runtime的, 也就是只在运行时会用到
如果 B 使用的 compile, 那么 C 就能直接访问 A 中的类, 但是这是官方不推荐的

Java Libraries

新增了 api 等定义方式 Java Library plugin

api 使用这种方式就可以更好的实现上文的需求, B 项目会被引用, 那么他就应该是一个库, 所以要考虑到 B 依赖的项目 是否也会被引用

  • B 项目中定义依赖: api A

C 项目就能使用 A 中的类了

Java applications

就是 Java 上加上了 MainClass 的配置, 使得打包的jar包可执行

其他依赖方式:

  1. 使用本地jar依赖 implementation files('lib/ojdbc-14.jar') lib 与 src 为同级目录
  2. 项目间依赖 implementation project(':projectName')
  3. 本地目录依赖 
    repositories {
    flatDir {
        dirs 'libs'
    }
}

依赖排除以及指定依赖版本

  1. 在 configuration 中排除
    configurations {
        compile.exclude module: 'commons'
        all*.exclude group: 'org.gradle.test.excludes', module: 'reports'
    }
  1. 在具体的某个dependency中排除
    dependencies{
        // 依赖排除
        compile(''){
            exclude group: '' // 按group排除
            exclude module: '' // 按 artifact 排除
            exclude grop: '', module: '' // 按 group artifact 排除
        }
        // 全局依赖排除
        all*.exclude group:'org.unwanted', module: 'iAmBuggy'

        // 禁用依赖传递
        compile('com.zhyea:ar4j:1.0') {
            transitive = false
        }
        
        configurations.all {
            transitive = false
        }

        // 强制使用指定版本的依赖
        compile('com.zhyea:ar4j:1.0') {
            force = true
        }
        // 始终使用最新的依赖,  若 1.+ 则是 1.xx版本的最新版
        compile 'com.zhyea:ar4j:+'
        
        configurations.all {
            resolutionStrategy {
                force 'org.hamcrest:hamcrest-core:1.3'
            }
        }
    }

统一管理依赖

完整示例 JavaBase

  1. 新建一个文件 dependency.gradle 
        rootProject.ext {
        ver = [
            junit     : '4.12',
        ]
        libs = [
            "junit"   : "junit:junit:$rootProject.ver.junit",
        ]
    }
  2. 在 build.gradle 中引入 apply from: 'dependency.gradle'
  3. 使用依赖时 只需 implementation rootProject.libs['junit'] 即使在子模块中也是如此使用

配置镜像源

阿里云

参考: 配置Gradle的镜像为阿里云镜像

当前项目的build.gradle

  repositories {
    mavenLocal()
    def aliyun = "http://maven.aliyun.com/nexus/content/groups/public/"
    def abroad = "http://central.maven.org/maven2/"
    maven {
      url = aliyun
      artifactUrls abroad
    }
    // 码云上自己的仓库
    maven {
      url = "https://gitee.com/gin9/MavenRepos/raw/master"
    }
    mavenCentral()
    jcenter()
  }

插件

引入一个插件有多种方式

    // 1
    apply plugin: 'java'
    // 2
    apply{
        'java'
    }
    // 3 Gradle5 推荐
    plugins{
        id 'java'
    }

Lombok

详细

Maven Publish

shadowJar

打包为 fat jar 也就是包含所有依赖jar的jar包

docker

提供Docker 的 API

  1. 引入 apply plugin: 'docker'
    • buildscript dependencies 中添加classpath('se.transmode.gradle:gradle-docker:1.2')

protobuf-gradle-plugin

Github: protobuf-gradle-plugin

setting.gradle

项目的配置信息, 一般存在这个文件的时候, Gradle就会认为当前目录是作为一个完整的根项目的, 并在当前目录添加 .gradle 目录

  • 必须: rootProject.name = '项目名'
  • 配置子项目 include('A','B')

Gradle多模块的构建

Official Doc: creating multi project builds

手动增加一个子项目

  1. mkdir test
  2. gradle init 然后删除自动创建的 setting.gradle
  3. setting.gradle 中的include 加入 test(项目名不是目录名)

另一种多模块的构建方式

参考博客:重拾后端之Spring Boot（六） -- 热加载、容器和多项目
全部在父项目build.gradle中配置

    // 一个典型的根项目的构建文件结构
    buildscript {
        //  构建脚本段落可以配置整个项目需要的插件，构建过程中的依赖以及依赖类库的版本号等
    }
    allprojects {
        //  在这个段落中你可以声明对于所有项目（含根项目）都适用的配置，比如依赖性的仓储等
    }
    subprojects {
        //  * 在这个段落中你可以声明适用于各子项目的配置（不包括根项目哦）
        version = "0.0.1"
    }
    //  * 对于子项目的特殊配置
    project(':common') {}
    project(':api') {}
    project(':report') {}
    project(':common') {
        dependencies {
            compile("org.springframework.boot:spring-boot-starter-data-rest")
            compile("org.springframework.boot:spring-boot-starter-data-mongodb")
            compile("org.projectlombok:lombok:${lombokVersion}")
        }
    }

    project(':api') {
        dependencies {
            compile project(':common')
            compile("org.springframework.boot:spring-boot-devtools")
        }
    }

    project(':report') {
        dependencies {
            compile project(':common')
            compile("org.springframework.boot:spring-boot-devtools")
            compile files(["lib/simsun.jar"])
            compile("org.springframework.boot:spring-boot-starter-web")
        }
    }

使用

安装到本地仓库

含源码 install 或 deploy

    apply plugin: "maven-publish"

    // publish with source code
    task sourceJar(type: Jar) {
        from sourceSets.main.allJava
    }
    publishing {
        publications {
            mavenJava(MavenPublication) {
                from components.java
                artifact sourceJar {
                    classifier "sources"
                }
            }
        }
    }

上传至构件仓库

Official Doc

特别注意使用gpg, 如果按这下面的一堆文档跟着做的话你要保证你的gpg小于等于2.0版本, 不然就卡在这里了

参考项目 参考 官方文档 参考博客 最简单的方式就是利用码云等平台创建私服

打包部署

参考: Building Java Applications

不依赖Jar的项目

  1. 依据模板新建项目 gradle init --type java-application 
        // 主要是如下配置
    plugins {
        // Apply the java plugin to add support for Java
        id 'java'
        // Apply the application plugin to add support for building an application
        id 'application'
    }
    // Define the main class for the application
    mainClassName = 'App'
  2. add this config to build.gradle 
        jar {
        manifest {
            attributes 'Main-Class': 'base.Main'
        }
    }
  3. run : gradle clean jar && java -jar file

依赖Jar的项目

  • Gradle默认是只会打包源码，并不会打包依赖

原生方式打包含依赖的Jar,并设置mainClass

    task uberJar(type: Jar) {
        archiveClassifier = 'all-dependency'

        from sourceSets.main.output

        dependsOn configurations.runtimeClasspath
        from {
            configurations.runtimeClasspath.findAll { it.name.endsWith('jar') }.collect { zipTree(it) }
        }

        manifest {
            attributes 'Main-Class': 'com.xxx.Main'
        }
    }

通过插件

构建Docker镜像

用 Docker、Gradle 来构建、运行、发布一个 Spring Boot 应用

build.gradle

    apply plugin: 'docker'
    buildscript {
        ext {
            springBootVersion = '2.0.1.RELEASE'
        }
        repositories {
            mavenCentral()
        }
        dependencies {
            classpath("org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}")
            classpath('se.transmode.gradle:gradle-docker:1.2')
        }
    }
    task buildDocker(type: Docker, dependsOn: build) {
        //设置自动上传的话，命名就不能乱取了，仓库名/镜像名：tag
    //    push = true
        test.enabled=false
        applicationName = jar.baseName
        dockerfile = file('src/main/docker/Dockerfile')
        doFirst {
            copy {
                from war
                into stageDir
            }
        }
    }

Dockerfile

    FROM frolvlad/alpine-oraclejdk8:slim
    VOLUME /tmp
    # 配置通配符是为了不受版本影响
    ADD weixin*.war app.war
    # ENTRYPOINT ["java","-Djava.security.egd=file:/dev/./urandom","-jar","/app.war"]
    ENTRYPOINT ["java","-jar","/app.war"]
  • gradle buildDocker 即可构建镜像
  • 运行 docker run --name web --link postgre:db -p 5678:8889 -it 镜像 注意其中要关联PostgreSQL的容器

插件方式构建Docker镜像

参考 通过Gradle使用Docker部署 Spring Boot项目

我的码云 | 我的CSDN | 我的OSChina

Summary

Clone this wiki locally