工具使用——如何使用Gradle创建一个Spring Boot项
Gradle是什么?
GradleGradle是一款基于Apache Ant和Apache Maven概念的项目自动化构建工具。
也就是说,Gradle 只是一种工具,如果将软件项目和建筑项目类比,那么 Gradle 就完成了建筑材料的采购、管理以轮廓规划的工作。开发者告诉Gradle要在这块地建造一片园区(构建一个软件项目),需要在指定的水泥厂获取水泥、在指定的钢厂获取钢材(声明插件和依赖以及仓库)等等。那么Gradle就会去那些地方获得材料(获取依赖),并对空地进行轮廓规划(项目根目录生成)。
- “轮廓规划”:Gradle会完成整个项目中文件结构的梳理,并自动生成文件根目录。
- “材料采购、管理”:Gradle会对项目的外部依赖进行获取、管理,这种获取就是根据配置的依赖,去对应仓库下载;管理就是对于依赖配置的解析。
注:本文所说的Gradle都是集成在IntelliJ IDEA中的插件。另外的,还有基于Groovy的独立Gradle脚本。
如何使用build.gradle文件配置项目依赖
通过 IntelliJ IDEA 使用Gradle,需要在创建项目时通过 IntelliJ 的插件来引入Gradle Project。设置好GroupId、ArtfactId 后就可以得到如下的项目目录:
自动生成的HelloWorldDemo项目目录之后就要通过编辑build.gradle文件来配置整个项目的依赖了。
打开自动生成的build.gradle文件,会有如下内容:
group 'com.tw.jlhe'
version '1.0-SNAPSHOT'
apply plugin: 'java'
sourceCompatibility = 1.5
repositories {
mavenCentral()
}
dependencies {
testCompile group: 'junit', name: 'junit', version: '4.11'
}
其中group
、version
两项是之前创建项目时填入的信息,指出组织名称和版本信息。
apply plugin
指出要使用的插件。这里要知道,Gradle本身是提供一些用于自动化构建项目的功能(tasks),但是无法对使用任意一种语言、框架、还有IDE的项目都能实现自动化构建。所以这里就需要一些插件来扩充Gradle的功能。例如上述代码中的apply plugin: 'java'
即声明使用Java插件,该插件的使用意味着 Gradle 会尝试获取 Java 相关的文件、构建Java项目文件目录(包括一个main和一个test)并提供Java插件所附带的Gradle tasks(如assemble、check、build等tasks指令)。
sourceCompatibility
指出当前项目使用的Java的版本是JDK 1.5。这个可以根据本地的JRE和项目需求来修改。
repositories
指出获取外部依赖的仓库位置,mavenCentral()
其实封装了Maven central仓库的URL地址。
'dependencies '指出项目的外部依赖,这些依赖将会指引 Gradle 从配置的仓库中获取对应的 jar 包,放入External Libraries中。在配置了指定的依赖后,这个获取的过程完全是自动的。
那么要搭建一个基于SpringBoot的HelloWorld项目,build.gradle文件就可以这样写:
group 'com.tw.jlhe'
version '1.0-SNAPSHOT'
buildscript{
repositories{
mavenCentral()
}
dependencies{
classpath("org.springframework.boot:spring-boot-gradle-plugin:1.4.2.RELEASE")
}
}
apply plugin: 'java'
apply plugin: 'idea'
apply plugin: 'org.springframework.boot'
sourceCompatibility = 1.8
targetCompatibility = 1.8
jar{
baseName = 'gs-hello-world-demo'
version = '0.1.0'
}
repositories {
mavenCentral()
}
dependencies {
compile group: 'org.springframework.boot', name: 'spring-boot-starter-web', version: '1.4.2.RELEASE'
}
要注意其中buildscript{}
代码块。该块内声明的仓库和依赖是build.gradle所需要的依赖资源,而该代码块外的仓库和依赖是该项目项目所需要依赖资源。
这其中的区别在于build.gradle文件在被加载时,会优先加载buildscript
代码块(无论其位置在文件开头或结尾)。因为这个原因,一般在引入一些额外的插件(主要指开源项目、框架的插件包)时,需要先在该代码块中声明,之后才能使用apply plugin
来扩展到Gradle中。
下来Gradle就会为你下载依赖中指定的jar包了。完成后如下图:
依赖包目录我个人觉得Gradle这种依赖管理方式很是方便(也可能是由于我以前没有用过项目自动化构建工具,引包都是靠手工搜索、下载、导入)。
然后就可以开始书写Java代码啦!(HelloWorldDemo会另起一篇。)
完成后的目录如下:
下一步,就是让写好的代码运行起来。
使用Gradle命令
Gradle提供了一些命令行便于开发者使用。
在项目文件目录下输入
./gradlew tasks
就可以查看当前Gradle所支持的指令。如下:
Gradle tasks(部分)之所以是当前,是因为Gradle的tasks会根据引入的plugin而有所扩充。例如使用了apply plugin: 'java'
的项目,其tasks会多出assemble、check等tasks。而使用了apply plugin: 'org.springframwork.boot'
,其tasks则会多出bootRun等。
而每一个task后面都会声明该条task的作用。
那么,根据task的提示,我们只需执行
./gradlew bootRun
就可以启动Spring boot项目。
最终运行结果如下:
至此。