第一个Spring Boot项目:helloworld
本节从简单的helloworld程序开始介绍创建Spring Boot项目的方法和流程,以及Spring Boot项目结构,最后介绍项目中非常重要的pom.xml文件。
1.创建Spring Boot项目
有两种方式来构建Spring Boot项目的基础框架:
- 第一种是使用Spring官网提供的构建页面;
- 第二种是使用IntelliJ IDEA中的Spring插件。
(1)使用Spring官网提供的构建页面
步骤01 访问Spring官网。
步骤02 选择构建工具为Maven Project,编程语言选择Java,Spring Boot版本为2.7.13,填写项目基本信息,具体如图所示。
步骤03 单击Generate创建并下载项目压缩包。
步骤04 解压后,使用IDEA引入项目,选择File→Open File or Project,选择解压后的文件夹,单击OK按钮,项目即可创建完成。
(2)使用IDEA构建
步骤01 选择File→New→Project命令,弹出新建项目的对话框。
步骤02 选择Spring Initializr,单击Next按钮出现配置界面,IDEA已经帮助做了集成。如图所示,IDEA界面中的Group、Artifact等输入框就对应着项目的pom.xml中的groupId、artifactId等配置项。
- Group:一般输入公司域名,比如百度公司就会输入com.baidu,本次演示输入com.example 。
- Artifact:可以理解为项目的名称,用户根据实际情况来输入,本次演示输入helloworld。
- Dependencies:添加项目所依赖的Spring Boot组件,可以多选。
填完相关的信息之后,直接单击NEXT按钮来创建项目。
2.项目结构
基本上所有Java项目的结构都大同小异,Spring Boot项目的结构和其他Java项目的结构类似。但是,还是有必要从头讲一讲Spring Boot项目的结构,只有掌握了项目的基本结构,后面开发起来才会更加得心应手。
前面的第一个Spring Boot项目helloworld创建成功之后,接下来用IDEA打开。Spring Boot的基础结构共有3个主要目录,具体如下:
- src/main/java:程序开发以及主程序目录。
- src/main/resources:配置文件和资源文件目录。
- src/test/java:测试程序目录。
从上面我们可以了解到,新建的helloworld项目只有java、resources、test三个基础结构目录。通常,完整的项目包括前台页面、model实体、数据库访问、公共基础类等非常多的文件和目录。
1)java目录下的com.example.myproject为后台java文件的根目录,包括:
- Application.java:建议放到根目录下,是项目的启动类,注意Spring Boot项目只能有一个main()方法入口。
- comm:建议放置公共的类,如全局的配置文件、工具类等。
- model:主要用于实体(Entity)。
- repository:主要是数据库访问层代码。
- service:主要是业务类代码。
- web:负责前台页面访问的Controller路由。
2)resources目录下包括:
- static:存放Web访问的静态资源,如JS、CSS、图片等。
- templates:存放页面模板。
- application.properties:存放项目的配置信息。
3)test目录存放单元测试的代码,目录结构和java目录保持一致。
4)pom.xml用于配置项目依赖包以及其他配置。采用Spring Boot推荐的默认配置可以省掉很多设置。
当然,也可以根据技术规范进行调整。至此,我们的第一个Spring Boot项目就创建完成了。
3.pom.xml详解
Spring Boot项目根目录下的pom.xml文件是Maven项目中非常重要的配置文件。Gradle项目的配置文件是build.gradle,主要描述项目包的依赖和项目构建时的配置。pom.xml配置文件主要分为四部分,下面就来一一介绍pom.xml文件的各个组成部分以及它们的作用。
(1) 项目的描述信息
<groupId>com.example</groupId>
<artifactId>demo</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>demo</name>
<description>Demo project for Spring Boot</description>
上面的配置内容基本是创建项目时定义的有关项目的基本描述信息,其中比较重要的是groupId、artifactId。各个属性说明如下:
- groupId:项目的包路径。
- artifactId:项目名称。
- version:项目版本号。
- packaging:一般有jar、war两个值,表示使用Maven打包时是构建成JAR包还是WAR包。
- name:项目名称。
- description:项目描述。
(2)项目的依赖配置信息
此部分为项目的依赖信息,主要包括Spring Boot的版本信息和第三方组件的版本信息。
项目的依赖信息主要分为parent和dependencies两部分。
parent:配置父级项目的信息。Maven支持项目的父子结构,引入后会默认继承父级的配置。此项目中引入spring-boot-starter-parent定义Spring Boot的基础版本。
dependencies:配置项目所需要的依赖包,Spring Boot体系内的依赖组件不需要填写具体版本号,spring-boot-starter-parent维护了体系内所有依赖包的版本信息。另外,<dependency>
标签是Maven项目定义依赖库的重要标签,通过groupId、artifactId等“坐标”信息定义依赖库的路径信息。
(3) 构建时需要的公共变量
<properties>
<java.version>1.8</java.version>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<spring-boot.version>2.6.13</spring-boot.version>
</properties>
上面配置了项目构建时所使用的编码、输出所使用的编码,最后指定了项目使用的JDK版本。
(4) 构建配置
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
</plugin>
<plugins>
</build>
上面配置spring-boot-maven-plugin构建插件,将Spring Boot应用打包为可执行的JAR或WAR文件,然后以简单的方式运行Spring Boot应用。如果需要更改为Docker构建方式,则只要更改此部分即可。
4.第一个helloworld程序
helloworld示例程序演示Spring Boot项目究竟是如何运行的。
步骤01 在目录src\main\java\com\example\helloworld\controller下创建HelloController,然后添加/hello的路由地址和方法,示例代码如下:
@RestController
public class HelloController {
@RequestMapping("/hello")
public String hello() {
return "hello word!!!";
}
在上面的示例中,我们创建了HelloController并创建了一个hello()方法,最后使用@RestController和@RequestMapping注解实现HTTP路由。
1)@RestController表示HelloController为数据处理控制器。Spring Boot中有Controller和RestController两种控制器,都用来表示Spring中某个类是否可以接收HTTP请求,但不同的是:
- @Controller:返回数据和页面,处理HTTP请求。
- @RestController:返回客户端数据请求,主要用于RESTful接口。
可以说@RestController是@Controller与@ResponseBody的结合体,因而具有两个标注合并起来的作用。
2)@RequestMapping("/hello")提供路由映射,意思是"/hello"路径的HTTP请求都会被映射到hello()方法上进行处理。
步骤02 运行helloworld程序。
右击项目中的HelloApplication→run命令就可以启动项目。
通过系统的启动日志可以看到,系统运行在8080端口。如果需要切换到其他端口,可在application.properties配置文件中自行定义。
步骤03 打开浏览器,访问http://localhost:8080/hello地址,查看页面返回的结果。
访问/hello地址后,后台成功接收到页面请求并返回“hello word!!!”,说明我们的第一个Spring Boot项目运行成功。