gradle--build.gradle

水深无声 2023-02-20 12:20 12阅读 0赞

原文网址：[gradle--build.gradle\_IT利刃出鞘的博客-CSDN博客][gradle--build.gradle_IT_-CSDN]

# 其他网址 #

> [gradle的build.gradle详解\_霓虹深处-CSDN博客\_build.gradle][gradle_build.gradle_-CSDN_build.gradle]
> 
> [Gradle 教程\_w3cschool][Gradle _w3cschool]（不带子目录）
> 
> [Gradle User Guide 中文版][Gradle User Guide]（带子目录） （英文版：[Gradle User Manual][]）
> 
> [Gradle DSL Version 6.5][]（Gradle英文文档）

# 概述 #

> 一个项目中只放置一个build.gradle，一个项目代表一个组件（jar/war包），构建启动后Gradle会根据build.gradle实例化一个org.gradle.api.Project类，提供了对一个项目的基本配置。

**示例（一个完整的构建脚本）**

>     apply plugin: 'java'
>     apply plugin: 'eclipse'
>     sourceCompatibility = 1.5
>     version = '1.0'
>     
>     jar {
>         manifest {
>             attributes 'Implementation-Title': 'Gradle Quickstart', 'Implementation-Version': version
>         }
>     }
>     
>     repositories {
>         mavenCentral()
>     }
>     
>     dependencies {
>         compile group: 'commons-collections', name: 'commons-collections', version: '3.2'
>         testCompile group: 'junit', name: 'junit', version: '4.+'
>     }
>     
>     test {
>         systemProperties 'property': 'value'
>     }
>     
>     uploadArchives {
>         repositories {
>            flatDir {
>                dirs 'repos'
>            }
>         }
>     }

**属性**

> <table style="width:629px;"> 
> <tbody> 
> <tr> 
> <td style="width:326px;">属性名称</td> 
> <td style="width:116px;">所属</td> 
> <td style="width:184px;">说明</td> 
> </tr> 
> <tr> 
> <td style="width:326px;">group</td> 
> <td style="width:116px;">project</td> 
> <td style="width:184px;"></td> 
> </tr> 
> <tr> 
> <td style="width:326px;">version</td> 
> <td style="width:116px;">project</td> 
> <td style="width:184px;">项目版本（全局的）</td> 
> </tr> 
> <tr> 
> <td style="width:326px;">name(artifact)</td> 
> <td style="width:116px;">project</td> 
> <td style="width:184px;">一般写在settings.gradle</td> 
> </tr> 
> <tr> 
> <td style="width:326px;">sourceCompatibility = 1.8</td> 
> <td style="width:116px;">java插件</td> 
> <td style="width:184px;"></td> 
> </tr> 
> <tr> 
> <td style="width:326px;">targetCompatibility = 1.8</td> 
> <td style="width:116px;">java插件</td> 
> <td style="width:184px;"></td> 
> </tr> 
> <tr> 
> <td style="width:326px;">compileJava.options.encoding = 'UTF-8'&nbsp;</td> 
> <td style="width:116px;"></td> 
> <td style="width:184px;"></td> 
> </tr> 
> <tr> 
> <td style="width:326px;">compileTestJava.options.encoding = 'UTF-8'&nbsp;</td> 
> <td style="width:116px;"></td> 
> <td style="width:184px;"></td> 
> </tr> 
> </tbody> 
> </table>

**方法**

> <table style="width:284px;"> 
> <tbody> 
> <tr> 
> <td style="width:139px;">方法</td> 
> <td style="width:141px;">说明</td> 
> </tr> 
> <tr> 
> <td style="width:139px;">apply</td> 
> <td style="width:141px;">应用</td> 
> </tr> 
> <tr> 
> <td style="width:139px;">repositories</td> 
> <td style="width:141px;">添加仓库</td> 
> </tr> 
> <tr> 
> <td style="width:139px;">dependencies</td> 
> <td style="width:141px;">添加依赖</td> 
> </tr> 
> <tr> 
> <td style="width:139px;">buildscript</td> 
> <td style="width:141px;"></td> 
> </tr> 
> <tr> 
> <td style="width:139px;">allprojects</td> 
> <td style="width:141px;"></td> 
> </tr> 
> <tr> 
> <td style="width:139px;">subprojects</td> 
> <td style="width:141px;"></td> 
> </tr> 
> <tr> 
> <td style="width:139px;">configurations</td> 
> <td style="width:141px;"></td> 
> </tr> 
> </tbody> 
> </table>

# repositories\{\} #

**简介**

> repositories是project一个方法，闭包作为参数。若前边的仓库中找不到，再依次在下边的仓库中查找。
> 
>     repositories {
>         // 本地仓库，地址是maven本地仓库路径。不用写，默认先找本地仓库的。
>         // mavenLocal()
>         //maven私服，此处设置为ali的，地址是url
>         maven{ url "https://maven.aliyun.com/repository/public/" }
>         //远程仓库,地址是https://repo1.maven.org/maven2
>         mavenCentral()
>     }
> 
> 上边的mavenLocal对应maven的本地仓库，maven私服对应internal repository，mavenCentral()对应中央仓库，与maven一模一样，直接看这篇即可：[maven系列--镜像/仓库\_feiying0canglang的博客-CSDN博客][maven_--_feiying0canglang_-CSDN]
> 
> **gradle的版本与http**
> 
> gradle7.0及之后，url最好是安全协议，比如https，上边的http会报警告，解决方法
> 
>     maven{ url "http://maven.aliyun.com/nexus/content/groups/public" allowInsecureProtocol = true}

**修改仓库地址**

> Gradle、maven默认从中央仓库mavenCentral() 也就是 [http://repo1.maven.org/maven2/][http_repo1.maven.org_maven2]下载依赖包，但是在国内下载速度巨慢，我们只能使用国内的镜像。
> 
> **法1：全局配置**
> 
> 配置一个全局配置文件可以只配置一次。如果个别项目需要另外添加仓库地址，只需要在影响的项目下单独配置build.gradle文件增加repositories\{\}即可。  
> 下边将利用 阿里云开源镜像站 替换掉网络访问困难的 maven、jcenter。
> 
> .grable/init.grable
> 
>     allprojects {
>         repositories {
>     		def ALIYUN_REPO_NEW = 'https://maven.aliyun.com/repository/public'
>     		def ALIYUN_REPO_OLD = 'http://maven.aliyun.com/nexus/content/groups/public/'
>     
>             all { ArtifactRepository repo ->
>                 if (repo instanceof MavenArtifactRepository) {
>                     def url = repo.url.toString()
>      
>                     if (url.startsWith('https://repo.maven.apache.org/maven2/') 
>     						|| url.startsWith('https://repo.maven.org/maven2') 
>     						|| url.startsWith('https://repo1.maven.org/maven2') 
>     						|| url.startsWith('https://jcenter.bintray.com/')){
>                         //必须用双引号，不能用单引号
>     					project.logger.lifecycle "Repository ${repo.url} replaced by $ALIYUN_REPO_NEW."
>                         remove repo
>                     }
>                 }
>             }
>     		
>     		maven {
>     			url ALIYUN_REPO_NEW
>     			url ALIYUN_REPO_OLD
>     		}
>         }
>      
>         buildscript {
>      
>             repositories {
>                	def ALIYUN_REPO_NEW = 'https://maven.aliyun.com/repository/public'
>     			def ALIYUN_REPO_OLD = 'http://maven.aliyun.com/nexus/content/groups/public/'
>     			
>     			all { ArtifactRepository repo ->
>     				if (repo instanceof MavenArtifactRepository) {
>     					def url = repo.url.toString()
>     	 
>     					if (url.startsWith('https://repo.maven.apache.org/maven2/') 
>     							|| url.startsWith('https://repo.maven.org/maven2') 
>     							|| url.startsWith('https://repo1.maven.org/maven2') 
>     							|| url.startsWith('https://jcenter.bintray.com/')) {
>                             //必须用双引号，不能用单引号
>     						project.logger.lifecycle "Repository ${repo.url} replaced by $ALIYUN_REPO_NEW."
>     						remove repo
>     					}
>     				}
>     			}
>     			
>     			maven {
>     				url ALIYUN_REPO_NEW
>     				url ALIYUN_REPO_OLD
>     			}
>             }
>         }
>     }
> 
> **法2：每个项目单独配置**
> 
> 每个Gradle构建的项目中，在build.gradle做如下配置
> 
>     repositories {
>         //本地仓库，地址是maven本地仓库路径
>         mavenLocal()
>         //maven私服。此处设置为ali的旧库，地址是url
>         maven{ url "http://maven.aliyun.com/nexus/content/groups/public" }
>         //阿里云新库
>         maven { url "https://maven.aliyun.com/repository/central" }
>         maven { url "https://maven.aliyun.com/repository/google" }
>         maven { url "https://maven.aliyun.com/repository/gradle-plugin" }
>         maven { url "https://maven.aliyun.com/repository/jcenter" }
>         maven { url "https://maven.aliyun.com/repository/spring" }
>         maven { url "https://maven.aliyun.com/repository/spring-plugin" }
>         maven { url "https://maven.aliyun.com/repository/public" }
>         maven { url "https://maven.aliyun.com/repository/releases" }
>         maven { url "https://maven.aliyun.com/repository/snapshots" }
>         maven { url "https://maven.aliyun.com/repository/grails-core" }
>         maven { url "https://maven.aliyun.com/repository/mapr-public" }
>         maven { url "https://maven.aliyun.com/repository/apache-snapshots" }
>         //maven的里程碑版本。有些依赖只能在这里边找到
>         maven { url "https://repo.spring.io/milestone" }
>         maven { url 'https://repo.spring.io/libs-milestone' }
>         //远程仓库,地址是https://repo1.maven.org/maven2
>         mavenCentral()
>     }

**不同位置repositories的作用**

> <table style="width:639px;"> 
> <tbody> 
> <tr> 
> <td style="width:171px;">不同位置的代码示例</td> 
> <td style="width:465px;">说明</td> 
> </tr> 
> <tr> 
> <td style="width:171px;"> build.gradle repositories { ... } dependencies { ... } </td> 
> <td style="width:465px;">根级别的repositories主要是为了当前项目提供所需依赖包，比如log4j、spring-core等依赖包可从mavenCentral仓库获得。</td> 
> </tr> 
> <tr> 
> <td style="width:171px;"> build.gradle buildscript { &nbsp;&nbsp; &nbsp;repositories { &nbsp;&nbsp; &nbsp;... &nbsp;&nbsp; &nbsp;} &nbsp;&nbsp; &nbsp;dependencies { &nbsp;&nbsp; &nbsp;... &nbsp;&nbsp; &nbsp;} } </td> 
> <td style="width:465px;">buildScript块的repositories主要是为了Gradle脚本自身的执行，可以声明的资源包括依赖项、第三方插件、maven仓库地址等。我在写的一篇博客<a href="http://blog.sina.com.cn/s/blog_72ef7bea0102vvju.html" title="《尝试Artifactory》" rel="nofollow">《尝试Artifactory》</a>中Gradle脚本需要com.jfrog.artifactory插件才能执行成功，而这个插件是从URL为https://plugins.gradle.org/m2/的Maven仓库获得。</td> 
> </tr> 
> <tr> 
> <td style="width:171px;"> build.gradle allprojects { &nbsp;&nbsp; &nbsp;repositories { &nbsp;&nbsp; &nbsp;... &nbsp;&nbsp; &nbsp;} &nbsp;&nbsp; &nbsp;dependencies { &nbsp;&nbsp; &nbsp;... &nbsp;&nbsp; &nbsp;} } </td> 
> <td style="width:465px;">allprojects块的repositories用于多项目构建，为所有项目提供共同所需依赖包。而子项目可以配置自己的repositories以获取自己独需的依赖包。</td> 
> </tr> 
> </tbody> 
> </table>

# dependencies\{\} #

**简介**

> dependencies是project一个方法，闭包作为参数。

**依赖范围**

> 其他网址： 
> [gradle依赖：implementation 和compile的区别 - 简书Managing Dependencies of JVM Projects][gradle_implementation _compile_ - _Managing Dependencies of JVM Projects]（官网文档）
> 
> <table> 
> <tbody> 
> <tr> 
> <td style="width:218.25pt;"> 项 </td> 
> <td style="width:381.8pt;"> 说明 </td> 
> </tr> 
> <tr> 
> <td style="width:218.25pt;"> compile/testCompile&nbsp;&nbsp;&nbsp; //deprecated implementation/testImplementation </td> 
> <td style="width:381.8pt;"> compile在3.x及之后依然能用。 </td> 
> </tr> 
> <tr> 
> <td style="width:218.25pt;"> compileOnly/testCompileOnly </td> 
> <td style="width:381.8pt;"> 只在编译时有效，不会参与打包&nbsp; </td> 
> </tr> 
> <tr> 
> <td style="width:218.25pt;"> compileClasspath testCompileClasspath </td> 
> <td style="width:381.8pt;"> 继承自：compile, compileOnly, implementation 继承自：testCompile, testCompileOnly, testImplementation </td> 
> </tr> 
> <tr> 
> <td style="width:218.25pt;"> annotationProcessor </td> 
> <td style="width:381.8pt;"> 使能注解处理器。比如：lombok就要到。 </td> 
> </tr> 
> <tr> 
> <td style="width:218.25pt;"> runtime/testRuntime &nbsp; //deprecated runtimeOnly/testRuntimeOnly </td> 
> <td style="width:381.8pt;"> 编译时不会参与，很少用 </td> 
> </tr> 
> <tr> 
> <td style="width:218.25pt;"> runtimeClasspath testRuntimeClasspath </td> 
> <td style="width:381.8pt;"> 继承自：runtimeOnly, runtime, implementation 继承自：testRuntimeOnly, testRuntime, testImplementation </td> 
> </tr> 
> <tr> 
> <td style="width:218.25pt;"> archives </td> 
> <td style="width:381.8pt;"> uploadArchives任务会用到 </td> 
> </tr> 
> <tr> 
> <td style="width:218.25pt;"> default </td> 
> <td style="width:381.8pt;"> 继承自：runtimeClasspath </td> 
> </tr> 
> </tbody> 
> </table>
> 
> **implementation与compile区别**
> 
> compile： 普通的依赖, 第三方库在 module 中依赖后其他 module 都可以使用该库 
> implementation：将该依赖隐藏在内部，而不对外部公开。它仅仅对当前的m`odule`提供接口。
> 
> 例如我们当前项目结构如下
> 
> ![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZlaXlpbmcwY2FuZ2xhbmc_size_16_color_FFFFFF_t_70][]
> 
> LibraryA 中引用了 LibraryC 的库，如果对 LibraryC 的依赖用的是 implementation 关键字。 如下：
> 
> dependencies {
> . . . . 
> implementation project（path：'：libraryC'）
> }
> 
> 那么LibraryC 中的接口，仅仅只能给 LibraryA 使用，而我们的 App Module 是无法访问到 LibraryC 提供的接口的，也就是将该依赖隐藏在内部，而不对外部公开。这就是implementation关键字的作用。
> 
> **建议**
> 
> 在Google IO 相关话题的中提到了一个建议，就是依赖首先应该设置为implementation的，如果没有错，那就用implemention，如果有错，那么使用compile指令，这样会使编译速度有所增快。
> 
> 那为什么要这么做呢？ 
> 答案是： 1. 加快编译速度。2. 隐藏对外不必要的接口。
> 
> 为什么能加快编译速度呢？
> 
> 这对于大型项目含有多个`Module`模块的， 以上图为例，比如我们改动 `LibraryC` 接口的相关代码，这时候编译只需要单独编译`LibraryA`模块就行， 如果使用的是`api`或者旧时代的`compile`，由于`App Module` 也可以访问到 `LibraryC`,所以 `App Module`部分也需要重新编译。当然这是在全编的情况下。

**写法**

> **单个依赖**
> 
>     dependencies {
>         //写法1
>         compile group: 'ch.qos.logback', name: 'logback-classi', version: '1.2.3'
>         //写法2
>         compile "ch.qos.logback:logback-classic:1.2.3"
>     }

> **多个依赖**
> 
>     dependencies {
>         //写法1
>         compile "javax.servlet:javax.servlet-api:3.1-b07"
>         compile "org.slf4j:slf4j-log4j12:1.7.5"
>         //写法2
>         compile (  
>             "javax.servlet:javax.servlet-api:3.1-b07",  
>             "org.slf4j:slf4j-log4j12:1.7.5"
>         )  
>     }

> **工程依赖**
> 
> 同一个构建中可以建立工程依赖，一个工程的 jar 包可以提供给另外一个工程使用。例如我们可以让 api 工程以依赖于 my\_base 工程的 jar 包。这样 Gradle 在构建 api 之前总是会先构建 my\_base工程。
> 
> api工程的build.gradle文件：
> 
>     dependencies {
>         compile project(':my_base')
>     }

> **文件夹下的jar依赖**
> 
> 可以依赖指定文件夹下的jar文件，如，依赖lib目录下所有的jar文件
> 
>     dependencies {
>         implementation fileTree(dir:'lib',includes:['*.jar'])
>     }

# buildscript\{\} #

**简介**

> gradle在执行脚本时，会优先执行buildscript代码块中的内容，然后才会执行剩余的build脚本。
> 
> 如果你想在脚本中使用一些第三方的插件、类库等，就需要自己手动添加对这些插件、类库的 引用。而这些插件、类库又不是直接服务于项目的，而是支持其它build脚本的运行。所以你应当将这部分的引用放置在buildscript代码块中。

**项目实例**

buildscript {
        ext {
            springBootVersion = '2.1.1.RELEASE'
            lombokVersion = '1.18.10'
        }
        repositories {
        	...
        }
        
        dependencies {
            classpath("org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}")
        }
    }
    
    apply plugin: 'java'
    apply plugin: 'org.springframework.boot'
    apply plugin: 'io.spring.dependency-management'
     
    group = 'abcd'
    version = '0.0.1-SNAPSHOT'
    sourceCompatibility = 1.8
    
    ext['springCloudVersion'] = 'Greenwich.RC2'
    
    dependencies {
      //Spring Boot
      compile('org.springframework.boot:spring-boot-starter')
      //Spring MVC
      compile('org.springframework.boot:spring-boot-starter-web')
      compile('org.springframework.boot:spring-boot-starter-aop')
      compile("org.projectlombok:lombok:${lombokVersion}")
    }
    
    dependencyManagement {
        imports {
            mavenBom "org.springframework.cloud:spring-cloud-dependencies:${springCloudVersion}"
        }
    }

# ext\{\} #

**其他网址**

> [ext官网文档][ext]

**简介**

> ext是Gradle领域对象的一个属性，我们可以将自定义的属性添加到ext对象上，Build.gradle中的其它代码片段可以使用。Gradle的属性可以用此命令打印出来：gradle properties。
> 
> ext属性是[ExtensionAware][]类型的一个特殊的属性，ExtentionAware接口的实现类为Project, Settings, Task, SourceSet等，ExtentionAware可以在运行时扩充属性，而这里的ext，就是里面的一个特殊的属性而已。
> 
> 一般单项目中，ext所在类型为project，即，通过project.$\{key\}可以访问到；root项目中，ext所在类型为rootProject，即，通过rootProject.$\{key\}可以访问到。
> 
> gradle.properties跟build.gradle的ext\{\}有同样作用，见：[gradle系列--其他文件\_feiying0canglang的博客-CSDN博客][gradle_--_feiying0canglang_-CSDN]

**单项目示例**

> build.gradle
> 
>     buildscript {
>     	ext {
>     		springBootVersion = '2.1.1.RELEASE'
>     		lombokVersion = '1.18.10'
>     	}
>     	repositories {
>     		...
>     	}
>     
>     	dependencies {
>     		classpath("org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}")
>     	}
>     }
>     
>     apply plugin: 'java'
>     apply plugin: 'org.springframework.boot'
>     apply plugin: 'io.spring.dependency-management'
>     
>     group = 'abcd'
>     version = '0.0.1-SNAPSHOT'
>     sourceCompatibility = 1.8
>     
>     ext['springCloudVersion'] = 'Greenwich.RC2'
>     
>     dependencies {
>     	//Spring Boot
>     	compile('org.springframework.boot:spring-boot-starter')
>     	//Spring MVC
>     	compile('org.springframework.boot:spring-boot-starter-web')
>     	compile('org.springframework.boot:spring-boot-starter-aop')
>     	compile("org.projectlombok:lombok:${lombokVersion}")
>     }
>     
>     dependencyManagement {
>     	imports {
>     		mavenBom "org.springframework.cloud:spring-cloud-dependencies:${springCloudVersion}"
>     	}
>     }

**多项目示例**

> build.gradle（root项目）
> 
>     buildscript {
>     	...
>     }
>     allprojects {
>     	...
>     }
>     ...
>     ext {
>     	lombokVersion = '1.18.10'
>     }
> 
> build.gradle（module级项目）
> 
>     dependencies {
>     	compile("org.projectlombok:lombok:${rootProject.lombokVersion}")
>     	//这样也可以
>     	//compile("org.projectlombok:lombok:${rootProject.ext.lombokVersion}")
>     }

# sourceSets\{\} #

**其他网址**

> [The Java Plugin][]

**说明**

> Java插件默认的目录项目如下：
> 
>     src/main/java              //Production Java source.
>     src/main/resources         //Production resources, such as XML and properties files.
>     src/test/java              //Test Java source.
>     src/test/resources         //Test resources.
>     src/sourceSet/java         //Java source for the source set named sourceSet.
>     src/sourceSet/resources    //Resources for the source set named sourceSet

> 这个目录是可以修改的，例如：
> 
>     sourceSets {
>         main {
>             java {
>                 srcDirs = ['src/main/java', '../my_base/src/main/java']
>             }
>             /*resources {
>                 srcDirs = ['../my_base/main/resources']
>             } */
>         }
>     }
> 
> 这样修改之后，把base（根项目）放到子项目同级路径之下，子项目就可以包含根项目了。

# 其他 #

## allprojects\{\} ##

## subprojects\{\} ##

## configurations\{\} ##

## artifacts\{\} ##

## publishing\{\} ##

[gradle--build.gradle_IT_-CSDN]: https://knife.blog.csdn.net/article/details/106975649
[gradle_build.gradle_-CSDN_build.gradle]: https://blog.csdn.net/qq_36850813/article/details/93996333
[Gradle _w3cschool]: https://www.w3cschool.cn/gradle/
[Gradle User Guide]: https://dongchuan.gitbooks.io/gradle-user-guide-/
[Gradle User Manual]: https://docs.gradle.org/current/userguide/userguide.html
[Gradle DSL Version 6.5]: https://docs.gradle.org/current/dsl/index.html
[maven_--_feiying0canglang_-CSDN]: https://blog.csdn.net/feiying0canglang/article/details/108054850
[http_repo1.maven.org_maven2]: http://repo1.maven.org/maven2/
[gradle_implementation _compile_ - _Managing Dependencies of JVM Projects]: https://docs.gradle.org/current/userguide/java_plugin.html#sec:java_plugin_and_dependency_management
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZlaXlpbmcwY2FuZ2xhbmc_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/2020062623441459.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ZlaXlpbmcwY2FuZ2xhbmc=,size_16,color_FFFFFF,t_70
[ext]: https://docs.gradle.org/current/dsl/org.gradle.api.plugins.ExtraPropertiesExtension.html#org.gradle.api.plugins.ExtraPropertiesExtension
[ExtensionAware]: https://links.jianshu.com/go?to=https%3A%2F%2Fdocs.gradle.org%2Fcurrent%2Fdsl%2Forg.gradle.api.plugins.ExtensionAware.html
[gradle_--_feiying0canglang_-CSDN]: https://blog.csdn.net/feiying0canglang/article/details/106975686
[The Java Plugin]: https://docs.gradle.org/current/userguide/java_plugin.html#sec:java_project_layout

gradle--build.gradle

发表评论取消回复

还没有评论，来说两句吧...

相关阅读