当前位置: 首页 > 工具软件 > Gradle > 使用案例 >

Gradle安装和配置详解

章玮
2023-12-01

Gradle安装和配置详解

gradle是基于Apache Ant和Apache Maven概念的项目自动化构建开源工具,也提供了很多第三方插件。在Java Web项目中通常会用到 java、war、maven等插件管理项目,实现项目自动构建、jar依赖等功能。
本章记录作者在 windows 系统中安装、配置 gradle-7.4.2的完整过程。

1. 下载安装包

  • 官网地址https://gradle.org/releases/

  • 直接解压

​ D:\ProgramFiles\gradle-7.4.2

注意:可以参考自己的IDEA选择版本,查看当前IDEA支持的Gradle版本:C:\Program Files\JetBrains\IntelliJ IDEA 2022.2\plugins\gradle

2. 配置环境变量

  • 需要有jdk8以上的版本
  • 添加GRADLE_HOME
  • path下添加%GRADLE_HOME%\bin

Gradle修改本地仓库的位置

Gradle和Maven都是当前热门的自动化构建工具。使用Gradle去构建项目,由于没有办法像Maven一样配置Setting文件来修改本地库的位置,我们可以通过设置环境变量GRADLE_USER_HOME的路径来改变gradle的本地仓库的位置。

因为Gradle如果不配置环境变量,则会在用户主目录下(Windows下是C:\Users\xxx目录)创建.gradle目录,并将下载的依赖文件保存在这个目录里。

如果不想使用缺省目录,则可以设置环境变量GRADLE_USER_HOME的路径,就可改变gradle的仓库目录。

当然gradle也是可以使用maven的仓库的。

3. 验证

  • gradle -v
C:\Users\pplsunny>gradle -v

Welcome to Gradle 7.4.2!

Here are the highlights of this release:
 - Aggregated test and JaCoCo reports
 - Marking additional test source directories as tests in IntelliJ
 - Support for Adoptium JDKs in Java toolchains

For more details see https://docs.gradle.org/7.4.2/release-notes.html


------------------------------------------------------------
Gradle 7.4.2
------------------------------------------------------------

Build time:   2022-03-31 15:25:29 UTC
Revision:     540473b8118064efcc264694cbcaa4b677f61041

Kotlin:       1.5.31
Groovy:       3.0.9
Ant:          Apache Ant(TM) version 1.10.11 compiled on July 10 2021
JVM:          11.0.15.1 (Oracle Corporation 11.0.15.1+2-LTS-10)
OS:           Windows 10 10.0 amd64

C:\Users\pplsunny>

4. 配置阿里云仓库

  • 阿里云仓库使用指南https://developer.aliyun.com/mvn/guide
    在 build.gradle 文件中加入以下代码:
allprojects {
  repositories {
    maven {
      url 'https://maven.aliyun.com/repository/public/'
    }
    mavenLocal()
    mavenCentral()
  }
}

我的配置

修改 maven 下载源
Gradle 自带的 Maven 源地址是国外的,该 Maven 源在国内的访问速度是很慢的,除非使用了特别的手段。一般情况下,
我们建议使用国内的第三方开放的 Maven 源或企业内部自建 Maven 源。

  • 认识 init.d 文件夹
    我们可以在 gradle 的 init.d 目录下创建以.gradle 结尾的文件,.gradle 文件可以实现在 build 开始之前执行,所以你可以在
    这个文件配置一些你想预先加载的操作。
    在 init.d 文件夹创建 init.gradle 文件
    拓展 1:启用 init.gradle 文件的方法有:

    1.在命令行指定文件,例如:gradle --init-script yourdir/init.gradle -q taskName。你可以多次输入此命令来指定多个init文件
    2.把init.gradle文件放到 USER_HOME/.gradle/ 目录下
    3.把以.gradle结尾的文件放到 USER_HOME/.gradle/init.d/ 目录下
    4.把以.gradle结尾的文件放到 GRADLE_HOME/init.d/ 目录下
    如果存在上面的4种方式的2种以上,gradle会按上面的1-4序号依次执行这些文件,如果给定目录下存在多个init脚本,会
    按拼音a-z顺序执行这些脚本,每个init脚本都存在一个对应的gradle实例,你在这个文件中调用的所有方法和属性,都会
    委托给这个gradle实例,每个init脚本都实现了Script接口。

    拓展 2:仓库地址说明

    mavenLocal(): 指定使用maven本地仓库,而本地仓库在配置maven时settings文件指定的仓库位置。如E:/repository,gradle
    查找jar包顺序如下:USER_HOME/.m2/settings.xml >> M2_HOME/conf/settings.xml >> USER_HOME/.m2/repository

    maven { url 地址},指定maven仓库,一般用私有仓库地址或其它的第三方库【比如阿里镜像仓库地址】。

    mavenCentral():这是Maven的中央仓库,无需配置,直接声明就可以使用。
    jcenter():JCenter中央仓库,实际也是是用的maven搭建的,但相比Maven仓库更友好,通过CDN分发,并且支持https访
    问,在新版本中已经废弃了,替换为了mavenCentral()。

    总之, gradle可以通过指定仓库地址为本地maven仓库地址和远程仓库地址相结合的方式,避免每次都会去远程仓库下载
    依赖库。这种方式也有一定的问题,如果本地maven仓库有这个依赖,就会从直接加载本地依赖,如果本地仓库没有该
    依赖,那么还是会从远程下载。但是下载的jar不是存储在本地maven仓库中,而是放在自己的缓存目录中,默认在
    USER_HOME/.gradle/caches目录,当然如果我们配置过GRADLE_USER_HOME环境变量,则会放在
    GRADLE_USER_HOME/caches目录,那么可不可以将gradle caches指向maven repository。我们说这是不行的,caches下载
    文件不是按照maven仓库中存放的方式

    拓展 3:阿里云仓库地址请参考:https://developer.aliyun.com/mvn/guide

    allprojects {
        repositories {
            mavenLocal()
            maven { name "Alibaba" ; url "https://maven.aliyun.com/repository/public" }
            maven { name "Bstek" ; url "https://nexus.bsdn.org/content/groups/public/" }
            mavenCentral()
    	}
    
        buildscript {
            repositories {
                maven { name "Alibaba" ; url 'https://maven.aliyun.com/repository/public' }
                maven { name "Bstek" ; url 'https://nexus.bsdn.org/content/groups/public/' }
                maven { name "M2" ; url 'https://plugins.gradle.org/m2/' }
            }
        }
    }
    
  • 在gradle-7.4.2\init.d目录下创建init.gradle文件

简洁版

buildscript { 
	repositories { 
		maven { url 'https://maven.aliyun.com/repository/gradle-plugin' } 
		maven { url 'https://plugins.gradle.org/m2/' }
	}
}
allprojects {
    repositories {
        def ALIYUN_REPOSITORY_URL = 'https://maven.aliyun.com/repository/public/'
        all { ArtifactRepository repo ->
            if(repo instanceof MavenArtifactRepository){
                def url = repo.url.toString()
                if (url.startsWith('https://repo1.maven.org/maven2')||url.startsWith('https://jcenter.bintray.com')) {
                    project.logger.lifecycle "Repository ${repo.url} replaced by $ALIYUN_REPOSITORY_URL."
                    remove repo
                }
            }
        }
        maven { 
			url ALIYUN_REPOSITORY_URL
		}
    }
}

详细版

allprojects{
    repositories {
        def ALIYUN_CENTRAL_URL = 'https://maven.aliyun.com/repository/central'
        def ALIYUN_JCENTER_URL = 'https://maven.aliyun.com/repository/public'
        def ALIYUN_GOOGLE_URL = 'https://maven.aliyun.com/repository/google'
        def ALIYUN_GRADLE_PLUGIN_URL = 'https://maven.aliyun.com/repository/gradle-plugin'
        def ALIYUN_SPRING_URL = 'https://maven.aliyun.com/repository/spring'
        def ALIYUN_SPRING_PLUGIN_URL = 'https://maven.aliyun.com/repository/spring-plugin'
        def ALIYUN_GRAILS_CORE_URL = 'https://maven.aliyun.com/repository/grails-core'
        def ALIYUN_APACHE_SNAPSHOT_URL = 'https://maven.aliyun.com/repository/apache-snapshots'

        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_CENTRAL_URL
            url ALIYUN_JCENTER_URL
            url ALIYUN_GOOGLE_URL
            url ALIYUN_GRADLE_PLUGIN_URL
            url ALIYUN_SPRING_URL
            url ALIYUN_SPRING_PLUGIN_URL
            url ALIYUN_GRAILS_CORE_URL
            url ALIYUN_APACHE_SNAPSHOT_URL
        }
    }
}
 类似资料: