详解SpringBoot项目的创建与单元测试

前言

  Spring Boot 设计之初就是为了用最少的配置,以最快的速度来启动和运行 Spring 项目。Spring Boot使用特定的配置来构建生产就绪型的项目。

Hello World

1.可以在 Spring Initializr上面添加,也可以手动在 pom.xml中添加如下代码∶

<dependency>
 <groupId>org.springframework.boot</groupId>
 <artifactId>Spring-boot-starter-web</artifactId>
</dependency>

pom.xml 文件中默认有个模块∶

<dependency>
 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-starter-test</artifactId>
 <scope>test</scope>
</dependency>

<scope>test</scope>表示依赖的组件仅仅参与测试相关的工作,包括测试代码的编译和执行,不会被打包包含进去;spring-boot-starter-test 是 Spring Boot 提供项目测试的工具包,内置了多种测试工具,方便我们在项目中做单元测试、集成测试。

2. 编写 Controller 内容

在目录 src\main\java\下新建一个包:com.reminis.web,然后在该包下创建 HelloController∶

@RestControler 的意思是 Contoller 里面的方法都以JSON格式输出,不需要有其他额外的配置;如果配置为@Controller,代表输出内容到页面。
@RequestMapping("hello")提供路由信息,"hello"路径的HTTP Request 都会被映射到hello()方法上进行处理。
启动主程序
右键单击项目中的 DemoAppicationrun命令,就可以启动项目了,若出现以下内容表示启动成功∶

@RestController
public class HelloController {
 @RequestMapping("/hello")
 public String hello(){
  return "hello world";
 }
 }
  • @RestControler 的意思是 Contoller 里面的方法都以JSON格式输出,不需要有其他额外的配置;如果配置为@Controller,代表输出内容到页面。
  • @RequestMapping("hello")提供路由信息,"hello"路径的HTTP Request 都会被映射到hello()方法上进行处理。

3.启动主程序

右键单击项目中的 DemoAppicationrun命令,就可以启动项目了,若出现以下内容表示启动成功∶

如果启动过程中出现javaClassNotFoundException 异常,请检查 M aven 配置是否正确,具体如下:

  • 检查 Maven 的 settigs.xml文件是否引入正确。
  • 检查 IDE 工具中的 Maven插件是否配置为本机的 Maven地址,如下图

Spring Boot 还提供了另外两种启动项目的方式∶

  • 在项目路径下,使用命令行mvnspring-boot∶run来启动,其效果和上面"启动主程序"的效果是一致的;
  • 或者将项目打包,打包后以Jar 包的形式来启动。
 # 进行项目根目录
 cd ../demo
 # 执行打包命令
 mvn clean package
 # 以 Jar 包的形式启动
 java -jar target/hello-0.0.1-SNAPSHOT.jar

启动成功后,打开浏览器输入网址∶http∶//localhost:8080/hello, 就可以看到以下内容了∶

开发阶段建议使用第一种方式启动,便于开发过程中调试。

4. 如果我们想传入参数怎么办?

  请求传参一般分为URL地址传参和表单传参两种方式,两者各有优缺点,但基本都以键值对的方式将参数传递到后端。作为后端程序不用关注前端采用的那种方式,只需要根据参数的键来获取值,Spring提供了很多种参数接收方式,本章我们了解最简单的方式∶通过 URL传参。只要后端处理请求的方法中存在参数键相同名称的属性,在请求的过程中Spring会自动将参数值赋值到属性中,最后在方法中直接使用即可。下面我们以 hello()为例进行演示。

@RestController
public class HelloController {

 @RequestMapping("/hello")
 public String hello(String name) {
  System.out.println("name..." + name);
  return "hello world, " + name;
 }
}

重新启动项目,打开浏览器输入网址 http∶//localhost8080/hello?name=reminis,返回如下内容:

到这里,我们的第一个 Spring Boot项目就开发完成了,有没有感觉很简单?经过测试发现,修改Controllr内相关的代码,需要重新启动项目才能生效,这样做很麻烦是不是?别着急,Spring Boot又给我们提供了另外一个组件来解决。

热部署

  热启动就需要用到一个组件∶spring-boot-devtools。它是 Spring Boot 提供的一组开发工具包,其中就包含我们需要的热部署功能,在使用这个功能之前还需要再做一些配置。

添加依赖

在 pom.xml文件中添加 spring-boot-devtools 组件。

  <dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-devtools</artifactId>
   <optional>true</optional>
  </dependency>

在 plugin 中配置另外一个属性 fork,并且配置为 true。

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

OK,以上的配置就完成了,如果你使用的是 Eclipse 集成开发环境,那么恭喜你大功告成了;如果你使用的是 IDEA 集成开发环境,那么还需要做以下配置。配置 IDEA
选择 File-Settings-Compiler 命令,然后勾选 Build project automati cally复选框,低版本的 IDEA请勾选make project automatically 复选框。

使用快捷键Ctrl+Shift+A,在输入框中输入 Registry,勾选 复选框∶

全部配置完成后,IDEA 就支持热部署了,大家可以试着去改动一下代码,等待5秒就会发现 Spring Boot会自动重新加载,再也不需要手动单击重新启动了。

为什么 IDEA需要多配置后面这一步呢?因为 IDEA默认不是自动编译的,需要我们手动去配置后才会自动编译,而热部署依赖于项目的自动编译功能。
该模块在完整的打包环境下运行的时候会被禁用,如果你使用 java-jar 启动应用或者用一个特定的classloader 启动,它会认为这是一个"生产环境"。

单元测试

  单元测试在我们日常开发中必不可少,一个优秀的程序员,单元测试开发也非常完善。下面我们看下 Spring Boot 对单元测试又做了哪些支持?

如果我们只想运行一个hello world,只需要一个@Test 注解就可以了。在src/test 目录下新建一个 HelloTest类,代码如下∶

public class HelloTest {
 @Test
 private void hello() {
  System.out.println("hello world");
 }
}

右键单击"运行"按钮,发现控制台会输出∶hello world。如果需要测试 Web 层的请求呢? Spring Boot 也给出了支持。
以往我们在测试 Web 请求的时候,需要手动输入相关参数在页面测试查看效果,或者自己写post 请求。在 Spring Boot体系中,Spring 给出了一个简单的解决方案,使用 MockMVC进行 Web测试, MockMVC内置了很多工具类和方法,可以模拟 post、get 请求,并且判断返回的结果是否正确等,也可以利用 print()打印执行结果。

@SpringBootTest(classes = DemoApplication.class)
class DemoApplicationTests {

 private MockMvc mockMvc;

 @BeforeEach
 public void setUp() {
  mockMvc = MockMvcBuilders.standaloneSetup(new HelloController()).build();
 }

 @Test
 public void getHello() throws Exception {
  mockMvc.perform(MockMvcRequestBuilders
    .post("/hello?name=reminis")
    .accept(MediaType.APPLICATION_JSON))
    .andDo(MockMvcResultHandlers.print());
 }
}

@BeforeEach注解的方法表示在测试启动的时候优先执行,一般用作资源初始化。由于我的SpringBoot项目版本是2.4.3,集成的是Junit5,JUnit5的环境下, @BeforeEach 和@AfterEach去替代@Before和@After注解。Junit4是使用@Before和@After注解.

在类的上面添加@SpringBootTest,系统会自动加载 Spring Boot 容器。在日常测试中,可以注入bean 来做一些局部的业务测试。MockMvcRequestBuilders 可以支持 post、get 请求,使用 MockMvcResultHandlers.print() 方法会将请求和相应的过程都打印出来,具体如下∶

MockHttpServletRequest:
  HTTP Method = POST
  Request URI = /hello
  Parameters = {name=[reminis]}
   Headers = [Accept:"application/json"]
    Body = <no character encoding set>
 Session Attrs = {}

Handler:
    Type = com.reminis.demo.controller.HelloController
   Method = com.reminis.demo.controller.HelloController#hello(String)

Async:
 Async started = false
  Async result = null

Resolved Exception:
    Type = null
ModelAndView:
  View name = null
    View = null
   Model = null

FlashMap:
  Attributes = null

MockHttpServletResponse:
   Status = 200
 Error message = null
   Headers = [Content-Type:"application/json", Content-Length:"20"]
  Content type = application/json
    Body = hello world, reminis
 Forwarded URL = null
 Redirected URL = null
   Cookies = []
    Type = null

ModelAndView:
  View name = null
    View = null
   Model = null

FlashMap:
  Attributes = null

MockHttpServletResponse:
   Status = 200
 Error message = null
   Headers = [Content-Type:"application/json", Content-Length:"20"]
  Content type = application/json
    Body = hello world, reminis
 Forwarded URL = null
 Redirected URL = null
   Cookies = []

从返回的Body= hello world ,reminis可以看出请求成功了。当然每次请求都看这么多返回结果,不太容易识别,MockMVC提供了更多方法来判断返回结果,其中就有判断返回值。我们将上面的 getHello()方法稍稍进行改造,具体如下所示∶

 @Test
 public void getHello() throws Exception {
  mockMvc.perform(MockMvcRequestBuilders
    .post("/hello?name=reminis")
    .accept(MediaType.APPLICATION_JSON))
    /*.andDo(MockMvcResultHandlers.print())*/
    .andExpect(MockMvcResultMatchers.content(). string(Matchers.containsString("reminis")));
 }

MockMvcResultMatchers.content()这段代码的意思是获取到 Wceb 请求执行后的结果;Matchers.contansString("reminis"),判断返回的结果集中是否包含"reminis"这个字符串.

我们简单做一下对比,使用Spring Boot之前和使用之后。使用 Spring Boot 前∶

  • 配置 web.xml,加载Spring和 Spring MVC
  • 配置数据库连接、配置 Spring 事务
  • 配置加载配置文件的读取,开启注解
  • 配置日志文件
  • 配置完成之后部署 Tomcat 调试
  • 使用Spring Boot之后,仅仅三步即可快速搭建起一个Web项目∶
  • 页面配置导入到开发工具中
  • 进行代码编写
  • 运行

通过对比可以发现Spring Boot在开发阶段做了大量优化,非常容易快速构建一个项目。

以上就是详解SpringBoot项目的创建与单元测试的详细内容,更多关于SpringBoot项目创建与单元测试的资料请关注我们其它相关文章!

(0)

相关推荐

  • Springboot测试类没有bean注入问题解析

    这篇文章主要介绍了Springboot测试类没有bean注入问题解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下 其他乱七八糟配置就不扯了,先上项目结构图 配置好参数后我再src/test/java类测试访问数据库时发现bean没有正确的注入.值得注意的是,这个项目的启动类是叫App.java 所以我们必须在这个测试类上面加上注解: @RunWith(SpringRunner.class) @SpringBootTest(classes =

  • Springboot集成JUnit5优雅进行单元测试的示例

    为什么使用JUnit5 JUnit4被广泛使用,但是许多场景下使用起来语法较为繁琐,JUnit5中支持lambda表达式,语法简单且代码不冗余. JUnit5易扩展,包容性强,可以接入其他的测试引擎. 功能更强大提供了新的断言机制.参数化测试.重复性测试等新功能. ps:开发人员为什么还要测试,单测写这么规范有必要吗?其实单测是开发人员必备技能,只不过很多开发人员开发任务太重导致调试完就不管了,没有系统化得单元测试,单元测试在系统重构时能发挥巨大的作用,可以在重构后快速测试新的接口是否与重构前有

  • Springboot Mybatis-Plus数据库单元测试实战(三种方式)

      单元测试长久以来是热门话题,本文不会讨论需不需要写单测,可以看看参考资料1,我个人认为写好单测应该是每个优秀开发者必备的技能,关于写单测的好处在这里我就不展开讨论了,快速进入本文着重讨论的话题,如何写好数据库单测.   为什么要写数据库单测? 相信大家是不是有这样类似的经历,在写完复杂的sql语句后,自信满满的提测,发现很大一部分Bug都是因为sql语句出现问题了,要么少写逗号,要么漏了字段,悔不当初哇,为啥写完不多测测呢!   没关系!这就教你如何写数据库单测,让你轻松告别数据库相关bug

  • Mockito 结合 Springboot 进行应用测试的方法详解

    Spring Boot可以和大部分流行的测试框架协同工作:通过Spring JUnit创建单元测试:生成测试数据初始化数据库用于测试:Spring Boot可以跟BDD(Behavier Driven Development)工具.Cucumber和Spock协同工作,对应用程序进行测试. 在web应用程序中,我们主要是对Service层做单元测试,以前单元测试都是使用 junit4 ,对Controller层做集成测试或者接口测试,对Controller层的测试一般有两种方法:(1)发送htt

  • SpringBoot+redis配置及测试的方法

    1.创建项目时选择redis依赖 2.修改配置文件,使用SpringBoot就避免了之前很多的xml文件 2.1学过redis的同学都知道这个东西有集群版也有单机版,无论哪个版本配置起来都很简单 2.1.1首先找到配置文件 2.1.2然后配置集群版,直接在配置文件内编辑即可 2.1.3配置单机版 3.测试 找到测试文件夹,自动注入redis模板 4.分别测试操作String和Hash类型的数据 4.1操作String @Test public void testString(){ //操作Str

  • SpringBoot2 集成测试组件的七种方法

    一.背景描述 在版本开发中,时间段大致的划分为:需求,开发,测试: 需求阶段:理解需求做好接口设计: 开发阶段:完成功能开发和对接: 测试上线:自测,提测,修复,上线: 实际上开发阶段两个核心的工作,开发和流程自测,自测的根本目的是为自己提前解决可能出现的问题:如果缺少自测和提测两个关键步骤,那么问题就会被传递给更多的用户,产生更多的资源消耗: 自测是于开发而言,提测是对专业的测试人员而言,如果尽可能在自测阶段就发现问题,并解决问题,那么一个问题就不会影响到团队协作上的更多人员,如果一个简单的问

  • springboot+idea+maven 多模块项目搭建的详细过程(连接数据库进行测试)

    创建之前项目之前 记得改一下 maven  提高下载Pom速度 记得 setting 中要改 maven  改成 阿里云的.具体方法 网上查第一步 搭建parents 项目,为maven项目 ,不为springboot 项目 记得修改groupId 第二步 搭建多个子模块, honor-dao   honor-manager   honor-common记得创建 honor-manager 的时候 要把他的gruopId 改成com.honor.manager 这里爆红的原因是 因为 我做到后面

  • 使用@SpringBootTest注解进行单元测试

    概述 @SpringBootTest注解是SpringBoot自1.4.0版本开始引入的一个用于测试的注解.基本用法如下: 1. 添加Maven依赖 <properties> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> </properties> <parent> <groupId>org.springframework.boot</gro

  • SpringBoot内置tomcat调优测试优化

    问题 怎么配置springBoot 内置tomcat,才能使得自己的服务效率更高呢? 基础配置 Spring Boot 能支持的最大并发量主要看其对Tomcat的设置,可以在配置文件中对其进行更改.我们可以看到默认设置中,Tomcat的最大线程数是200,最大连接数是10000. 这个不同SpringBoot 版本可能有所细微差别.本文测试基于Springboot 2.0.7.RELEASE 默认配置 /** * Maximum amount of worker threads. */ priv

  • SpringBoot对Controller进行单元测试的实现代码 附乱码解决方案

    Controller代码 package com.keafmd.controller; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; import java.util.HashMap; import java.util.Map; /** * Keafmd * * @ClassName: Hel

  • 解决SpringBoot 测试类无法自动注入@Autowired的问题

    原来的测试类的注解: @RunWith(SpringRunner.class) @SpringBootTest 一直没法自动注入,后来在@SpringBootTest, 加入启动类Application后就可以了 @RunWith(SpringRunner.class) @SpringBootTest(classes = Application.class) 补充:spring boot项目单元测试时,@Autowired无法注入Service解决方式 首先确认: 测试类所在包名要和启动类一致

随机推荐