搭建第一个SpringBoot程序

2022年7月22日

Spring
Spring Boot

第一个程序

大约 3 分钟

搭建第一个SpringBoot程序

环境准备

一个比较不错的文本编辑器（例如Vim、Emacs、Sublime Text）或者IDE（Eclipse、IntelliJ IDEA）

Java环境（JDK 1.8或以上版本）

Maven 3.0+IntelliJ IDEA（Eclipse和IntelliJ IDEA内置，如果使用IDE并且不使用命令行工具可以不安装）。

maven构建项目

1）官网地址：http://start.spring.io/open in new window

2）选择构建工具

Project（项目）：Maven Project；
Language（语言）：Java；
Spring Boot（版本）：2.3.0M2；
Project Metadata（项目元数据）：Group [com.yoodb]和Artifact[demo]；
Dependencies（依赖关系）：
[Name：springboot-study-demo01；
Description：Demo project for Spring Boot；
Package name：com.yoodb.study.demo01；
Package name：War；Java（JDK）：8]，可参考如图所示：

Spring Boot2.3.0.M2这一个里程碑的主要包括：改进Docker镜像支持；升级到 MongoDB 4（仍处于 beta 版）；支持配置文件的通配符位置；众多依赖项升级。

3）点击“Generate-Crtl+”按钮下载项目压缩包；

4）解压后，使用IntelliJ IDEA，Project Settings -> + ，导入Maven项目后点击“OK”，如图所示：

5）选中右侧Maven菜单，执行install命令，等待执行完成，如图所示：

目录结构

Maven项目导入成功后，目录结构如下图所示：

Spring Boot的基础结构共三个文件：

src/main/java 程序开发以及主程序入口
src/main/resources 配置文件
src/test/java 测试程序

Spring boot官方建议的目录结果如下：

root package结构：com.example.yourproject

com
+- example
+- yourproject
+- Application.java
|
+- domain
| +- Customer.java
| +- CustomerRepository.java
|
+- service
| +- CustomerService.java
|
+- controller
| +- CustomerController.java
|

1）Application.java 建议放到根目录下面，主要用于做一些框架配置；

2）domain目录主要用于实体（Entity）与数据访问层（Repository）；

3）service 层主要是业务类代码；

4）controller 负责页面访问控制。

采用默认配置可以省去很多配置，当然也可以根据自己的喜欢来进行更改，到此一个Spring boot框架的Maven项目搭建完成。

Maven项目启动

编写controller类文件，代码如下所示：

package com.yoodb.study.demo01;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HelloWorldController {
    @RequestMapping("/hello")
    public String index() {
        return "关注微信公众号“Java精选”，Spring Boot系列文章持续更新中，带你从入门到精通，玩转Spring Boot框架。";
    }
}

注：@RestController的含义是controller里面的方法都以json格式输出。

启动主程序，执行如图所示：

打开浏览器访问http://localhost:8080/hello，就可以看到效果了，是不是感觉很简单，那么大家赶紧试一试吧！欢迎关注微信公众号“Java精选”，持续更新Spring Boot系列文章，供大家参考和学习。

Spring Boot如何做单元测试？

打开的src/test/下的测试入口，编写简单的http请求来测试；使用mockmvc进行，利用MockMvcResultHandlers.print()打印出执行结果。

@RunWith(SpringJUnit4ClassRunner.class)
@SpringApplicationConfiguration(classes = MockServletContext.class)
@WebAppConfiguration
public class HelloWorldControlerTests {
    
    private MockMvc mvc;
    
    @Before
    public void setUp() throws Exception {
        mvc = MockMvcBuilders.standaloneSetup(new HelloWorldController()).build();
    }
    
    @Test
    public void getHello() throws Exception {
        mvc.perform(MockMvcRequestBuilders.get("/hello").accept(MediaType.APPLICATION_JSON))
        .andExpect(MockMvcResultMatchers.status().isOk())
        .andDo(MockMvcResultHandlers.print())
        .andReturn();
    }
}

另外，官方提供了一种比较新的注解测试方法，具体代码参考如下：

@RunWith(SpringRunner.class)
@SpringBootTest
public class HelloWorldControlerTests {
    private MockMvc mvc;
    
    @Before
    public void setUp() throws Exception {
        mvc = MockMvcBuilders.standaloneSetup(new HelloWorldController()).build();
    }
    
    @Test
    public void getHello() throws Exception {
        mvc.perform(MockMvcRequestBuilders.get("/hello").accept(MediaType.APPLICATION_JSON))
        .andExpect(MockMvcResultMatchers.status().isOk())
        .andDo(MockMvcResultHandlers.print())
        .andReturn();
    }
}

Spring Boot开发环境的调试

热启动（热部署）在正常开发项目中已经很常见了，虽然平时开发web项目过程中，改动项目重启总是报错；但Spring Boot对调试支持很好，修改之后可以实时生效，需要添加以下的配置：

<dependencies>
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-devtools</artifactId>
      <optional>true</optional>
    </dependency>
</dependencies>
<build>
    <plugins>
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
            <configuration>
            <fork>true</fork>
            </configuration>
        </plugin>
    </plugins>
</build>