孔子说:“工欲善其事,必先利其器”。说得是做好一件事,准备工作是非常重要的。常见的开发Spring Boot项目的工具包括MyEclipse、IDEA,强烈推荐使用IDEA作为开发工具。IDEA和Spring Boot一起使用,个人认为是开发Java程序的最佳体验。项目的构建工具包括Apache Maven和Gradle,Gradle是一个基于Apache Ant和Apache Maven概念的项目自动化构建的工具。两个构建工具都非常方便,按个人习惯来选着,Apache Maven的使用率要高一些,所以选择介绍的构建工具为Apache Maven。
1 JDK的安装
1.1.1 JDK的下载和安装
由于Spring Boot在未来的版本2.0中要求最低的JDK版本为1.8,所以选择安装JDK的1.8。如果系统已经安装里的JDK,所有就不需要自己再安装,JDK的下载官网:JavaDownload
2 IDEA的安装
对于习惯使用Eclipse或者MyEclipse的开发者来说,可能不愿意换新的IDEA,因为需要花时间去学习,还要去适应新的开发工具。个人觉得,IDEA比Eclipse系列好用很多,它带来了不一样的开发体验,主要体现在一下5个方面:
- 有对用户更加友好的界面,有更加护眼的黑色主题,感觉更高端大气
- 比Eclipse更加只能,主要体现在代码的补全方面。
- 更加友好的代码提示功能
- 内置Maven、Gradle等构建工具,并且下载依赖包非常只能流畅。
- 更强大的纠错能力
虽然,Eclipse和IDEA都能开发出Java项目,Eclipse也非常好用,但两者的写代码体验不在一个级别上。IDEA具有更良好的界面和更智能的代码提示,以及更强大的纠错能力,所以IDEA写代码体验更好、效率更高。IDEA下载官网地址:IDEADownload
2.2.1 利用IDEA创建一个Spring Boot工程
IDEA提供了多种方式去创建工程,非常便捷。本案例采用Spring Initializr的方式来创建工程。选择 Create New Project,创建新工程,选择Spring Initializr创建Spring Boot工程。
单击Next,填写Group(例如“com.forezp”)和Artifact(例如“hello-world”),选择默认Maven工程,其他配置默认即可。单击Next,进入Spring Initializr模块选择界面,如图所示,Spring Initializr提供了很多可选的常见功能模块,大多数模块是与Spring Boot进行了整合的起步依赖的功能模块,例如Core提供了AOP、Security、Cache、Session等模块,Web提供了Web、Webservice、WebSocker等模块,读者可以自行查看相关模块的相关功能。本例中选择Web模块的Web功能,单击Next,然后单击Finish
单击Finish之后,IDEA会从会从Spring.io网站下载工程模板,下载完成后就是一个完整的Spring Boot工程。在工程的目录下有一个HelloWorldApplication类,该类为程序的启动类,在该类上添加@RestController注解,开启RestController的功能,写一个接口“/hi”,使用@GetMapping注解表明为Get类型的请求,具体代码如下:
@SpringBootApplication
@RestController
public class HelloWorldApplication {
public static void main(String[] args) {
SpringApplication.run(HelloWorldApplication.class, args);
}
@GetMapping("/hi")
public String hi() {
return "hi,I'm forezp";
}
}
启动HelloWorldApplication类的main方法,程序启动。程序启动完成后,在浏览器上输入http://localhost:8080/hi,浏览器会显示hi,I’m forezp。
3 构建工具Maven的使用
3.3.1 Maven介绍
Apache Maven是一款软件项目管理的开源工具,是基于工程对象模型(Pom)的概念而设计的,Maven可以管理项目构建的整个生命周期,包括清理(Clean)、编译(Compile)、打包(Package)、测试(Test)等环节。同时Maven提供了非常丰富的插件,使得构建项目和管理项目变得简单。构建一个项目所需的流程如下:
- 生成 源码
- 从源码中生成文档
- 编译源码
- 测试
- 将源码打包成JAR,运行在服务器、仓库或者其他位置
Apache Maven已经实现了以上的全部功能,并且只需要相关的命令就可以完成相关的功能
3.3.2 Maven的核心概念
Maven的核心是pom文件,pom文件以xml文件的形式来表示资源,包括一些依赖JAR插件、构建文件等。Maven的工作过程如图所示:
- 首先读取pom文件。pom文件是Maven的核心,所有的项目依赖、插件都在pom文件中统一管理
- 下载依赖Jar到本地仓库。Maven命令执行时,首先会检查pom文件的依赖Jar。当检查到本地没有安装依赖Jar时,默认会从Maven的中央仓库下载依赖Jar,中央仓库地址为:http://repo1.maven.org/maven2/。依赖Jar下载成功后,会存放在本地仓库中,如果下载不成功,则该命令执行不会被通过。
- 执行构建的生命周期。Maven的构建过程会被分解成构建阶段和构建目标,它们共同构成了Maven的生命周期。
- 执行构建插件。插件可以更方便的执行构建的各个阶段,也可以用插件实现一些额外的功能。目前Maven有非常丰富的插件,如果需要,你也可以自己实现Maven插件
3.3.3 编写POM文件
pom文件是一个xml文件,用于描述项目用到的资源、项目依赖、插件、代码位置等信息,是整个工程的核心。pom.xml文件一般放在项目的根目录下,以2.2.1工程为例编写pom.xml文件,代码如下:
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.3.2.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>cn.tedu</groupId>
<artifactId>HelloWorld</artifactId>
<version>0.0.1-SNAPSHOT</version>
<packaging>jar</packaging>
<name>HelloWorld</name>
<description>HelloWorld</description>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<java.version>1.8</java.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
pom.xml的第一行指定了xml的版本和编码方式。project的标签是该文件的根元素,它声明了pom相关的命名空间,modelVersion指定了pom的版本,对于Maven3来说,它的版本为4.0.0
groupId、artifactId和version是3个最重要的标签,根据这3个标签,就可以在Maven仓库中唯一确认该依赖JAR。其中groupId代表的公司、组织的名称,一般为公司的域名倒着写,如本例中的cn.tedu;artifactId代表该项目的全局唯一Id,如本例中HelloWorld;version是指定该项目的版本。将项目上传到Maven仓库中,有这3个标签才能准确无误的找到该Jar包。
parent标签用于指定父项目pom,本案例采用的父pom版本号为2.3.2.RELEASE的spring-boot-starter-parent的pom
properties标签用于声明一些常量,例如上述代码中的源码编码为UTF-8。输出代码也为UTF-8,Java版本为1.8
dependencies标签为依赖的根元素,里面可以包含多个dependency元素,dependency里具体个依赖的JAR的3个坐标,即groupId、artifactId、和version。其中version可以省略,如果省略,就会默认为最新发布的版本,
buold标签为构建标签,它可以包含piugins(插件)标签,plugins标签中可以包含若干个piugin标签,可以根据项目的需求添加相应的plugin。本例中有spring-boot-maven-plugin插件,用此插件可以启动Spring Boot工程。
3.3.4 Maven构建项目的生命周期
在Maven工程中,已经默认定义了工程的生命周期,不需要额外引用其他的插件,因为Maven本身就已经集成了这些插件。默认的生命周期包括了23个阶段,如表所示:
Maven构建工程的生命周期表
阶段 | 描述 |
---|---|
validate | 验证工程的完整性 |
initialize | 初始化 |
generate-resources | 生成源码 |
process-sources | 处理源码 |
generate-resources | 生成所有源码 |
process-resources | 处理所有源码 |
compile | 编译 |
process-classes | 处理class文件 |
generate-test-sources | 生成测试源码 |
process-test-source | 处理测试源码 |
generate-test-resource | 生成所有测试源码 |
process-test-resource | 处理所有测试源码 |
test-compile | 测试编译 |
process-test-classes | 处理测试class文件 |
test | 测试 |
prepare-package | 预打包 |
package | 打包(如Jar、War) |
pre-integration-test | 预集成测试 |
integration-test | 集成测试 |
post-integration-test | 完成集成测试 |
verify | 验证 |
install | 安装到本地仓库 |
deploy | 提交到远程仓库 |
3.3.5 常用的Maven命令
- mvn clean 删除工程的target目录下的所有文件
- mvn package将工程打包成Jar包
在终端上 输入 mvn oackage命令,终端最后会显示如下信息,证明工程打成Jar包成功。
[INFO] Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 1.609 s - in com.example.helloworld.HelloWorldApplicationTests
2022-07-26 12:21:24.781 INFO 9084 --- [extShutdownHook] o.s.s.concurrent.ThreadPoolTaskExecutor : Shutting down ExecutorService 'applicationTaskExecutor'
[INFO]
[INFO] Results:
[INFO]
[INFO] Tests run: 1, Failures: 0, Errors: 0, Skipped: 0
[INFO]
[INFO]
[INFO] --- maven-jar-plugin:3.2.0:jar (default-jar) @ HelloWorld ---
[INFO] Building jar: H:\Users\26233\IdeaProjects\SpringCloud-Project\HelloWorld\target\HelloWorld-0.0.1-SNAPSHOT.jar
[INFO]
[INFO] --- spring-boot-maven-plugin:2.3.2.RELEASE:repackage (repackage) @ HelloWorld ---
[INFO] Replacing main artifact with repackaged archive
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 13.265 s
[INFO] Finished at: 2022-07-26T12:21:26+08:00
[INFO] ------------------------------------------------------------------------
Process finished with exit code 0
上述的mvn package打包命令不是一个简单的命令,它是由一系列有序的命令构成的,mvn package命令执行过程包含6个阶段
- 验证
- 编译代码
- 处理代码
- 生成资源文件
- 生成Jar包
- 测试
- mvn package -Dmaven.test.skip=true
- mvn compile编译成成代码,不生成Jar包
- mvn install命令包含了mvn package的所有过程,并且生成的Jar包安装到本地仓库。执行mvn install命令,可以看到终端输出的日志,经过了与mvn package相同的阶段,最后将Jar包安装到本地仓库。终端显示 的日志如下:
- mvn spring-boot:run使用spring-boot插件,启动SpringBoot工程。该命令执行时先检查Spring Boot工程源码是否编译,如果工程源码没有编译,则先编译;如果编译了,则启动工程,启动后的工程日志如下:
- mvn test测试
- mvn idea:idea 生成idea项目
- mvn jar:jar 只打Jar包
- mvn validate 检查资源是否可用
总结:开发项目中开发环境的搭建和开发工具的使用,难免会有点枯燥,但却是开发微服务基础的前提。