SpringBoot 测试-Web层

项目环境

• SpringBoot project
• Controller 层的测试

SpringBoot test 涉及的几个方面

• 如何在 test 环境下引入/创建 SpringBoot 的 application context，如需要某个 controller 的 bean
• 要不要/及如何开启 Tomcat 服务器来验证实际Http请求，Controller层的测试可以不开启server吗，如果不开启如何测
• 开启Tomcat和将所有组件全部注入开销较大，有没有方式针对特定Controller所需bean 进行初始化
• full Spring application context 和 特定 application context 的概念
• Service 和 Dao 要不要依存在 Tomcat/mysql 下来测试
• Controller/Service/Dao 分层测试 VS 集成测试

前提

• 最开始几个例子 都不涉及 组件依赖，即 @controller 没有 autowire @Service 组件
• 后面会涉及 依赖注入的问题

代码

pom 依赖

    <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>

Controller

@RestController
@RequestMapping
public class BookController {
    @RequestMapping("/books")
    public String book() {
        System.out.println("controller");
        return "book";
    }
}

Test1 引入Spring上下文，但不启动tomcat

@RunWith(SpringRunner.class)
@SpringBootTest  //引入Spring上下文 -> 上下文中的 bean 可用，自动注入
public class BookControllerTest {
    
    @Autowired
    private BookController bookController;  //自动注入
    
    @Test
    public void testControllerExists() {
        Assert.assertNotNull(bookController);
    }
    
}

解释

• @SpringBootTest
  • 告知Spring boot寻找main configuration class(主要配置类)
  • 默认是 @SpringBootApplication 所修饰的类
  • 通过该主类 start Spring Application Context
  • bean 可以注入
• Spring 提供的测试支持可以将 Application Context 缓存起来，这会使同一个配置类下的上下文资源在不同test case 间共享，所有测试只会产生一次启动应用的开销
• @Autowired 注解的bean 在 测试方法运行前被注入
• 运行测试，通过 console 可以看到没有 Tomcat 的日志打出，Tomcat server未启动

Test2 引入Spring上下文，且启动Tomcat 模拟生产环境，接收Http请求

@RunWith(SpringRunner.class)
@SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT)  //RANDOM_PORT 启动Tomcat
public class BookControllerTest {
    
    @LocalServerPort
    private int port;

    @Autowired
    private TestRestTemplate testRestTemplate;
    
    @Test
    public void testBook() {
        Assert.assertEquals(this.testRestTemplate.getForObject("http://localhost:" + port + "/books", String.class), "book");
    }
    
}

解释

• webEnvironment=RANDOM_PORT 启动一个随意端口的Tomcat
• @LocalServerPort 自动注入随机端口
• @TestRestTemlpate Spring boot 提供一个TestRestTemplate，作为 Http Client
• 存在启动Tomcat的开销

Test3 引入Spring上下文，不启动Tomcat, 由 MockMVC 发送请求

@RunWith(SpringRunner.class)
@SpringBootTest  
@AutoConfigureMockMvc //启动自动配置MockMVC
public class BookControllerTest {

    @Autowired
    private MockMvc mockMvc; //只需 autowire
    
    @Test
    public void testBook2() throws Exception {
        this.mockMvc.perform(get("/books"))
                .andExpect(status().is(200))
                .andDo(MockMvcResultHandlers.print())
                .andExpect(content().string("book"))
                .andReturn();  
    }
    
}

解释

• @AutoConfigureMockMvc 启动自动配置 MockMvc
• mockmvc可执行 http client 的功能
• print 打印 mock http 详细信息
• console 没有打印 Tomcat日志信息，Tomcat 不启动
• full Spring application context is started

Test4 只引入Web 层 的Spring上下文，不启动Tomcat, 由 MockMVC 发送请求

@RunWith(SpringRunner.class)
//@SpringBootTest  //full Spring application context
@WebMvcTest
public class BookControllerTest {

    @Autowired
    private MockMvc mockMvc; //只需 autowire
    
    @Autowired  //可以正常注入
    private BookController bookController; 

    //@Autowired //另建@Service BookService 类，编译通过，但test运行时异常，不能注入 web 层以外的 bean
    private BookService bookService;
    
    @Test
    public void testBook2() throws Exception {
        this.mockMvc.perform(get("/books"))
                .andExpect(status().is(200))
                .andDo(MockMvcResultHandlers.print())
                .andExpect(content().string("book"))
                .andReturn();  
    }
    
}

解释

• @WebMvcTest 和 @SpringBootTest 性质一样，都是为了start 应用上下文
• @WebMvcTest 只能 启动 web 层的上下文
  • 能初始化：@Controller, @ControllerAdvice, @JsonComponent Filter, WebMvcConfigurer and HandlerMethodArgumentResolver beans
  • 不能初始化： @Component, @Service or @Repository beans
  • 还能初始化： Spring Security and MockMvc
• @SpringBootTest 可以启动所有上下文，资源开销不一样

Test5 只引入Web 层 特定Controller 的Spring上下文，不启动Tomcat, 由 MockMVC 发送请求

@RunWith(SpringRunner.class)
@WebMvcTest(BookControler.class) //明确指定引入的 哪个web controller 上下文
public class BookControllerTest {

    @Autowired
    private MockMvc mockMvc; //只需 autowire
    
    @Autowired  //可以正常注入
    private BookController bookController; 

    //@Autowired //另建@RestController BookController2 类，编译通过，但test运行时异常，不能注入 Book Controller以外的 bean
    private BookController2 BookController2;
    
    @Test
    public void testBook2() throws Exception {
        this.mockMvc.perform(get("/books"))
                .andExpect(status().is(200))
                .andDo(MockMvcResultHandlers.print())
                .andExpect(content().string("book"))
                .andReturn();  
    }
    
}

解释

• @WebMvcTest(SthController.class) 未加 class 属性的 时候注入所有 controller, 指明具体controller 则限制注入的对象
• 资源开销不一样

Test6 前5个例子都未涉及Controller的依赖问题，现在 controller 依赖 service

添加service

@Service
public class BookService {  //添加 Service 层
    public String addBook() {
        return "book";
    }
}

更改Controller，注入 service

@RestController
@RequestMapping
public class BookController {

    @Autowired
    private BookService bookService; //注入 依赖 service bean

    @RequestMapping("/books")
    public String addBook() {
        return bookService.addBook();
    }
}

Test 6-1 web layer application context

@RunWith(SpringRunner.class)
@WebMvcTest(BookControler.class) //明确指定引入的 哪个web controller 上下文
public class BookControllerTest {

    @Autowired
    private MockMvc mockMvc; //只需 autowire
    
    @MockBean //mock 伪造 一个 bookService bean 否则，上下文环境中不存在，因为指定了 @WebMvcTest，否则应用启动异常
    private BookService bookService;
    
    @Autowired  //可以正常注入
    private BookController bookController; 

    
    @Test
    public void testBook2() throws Exception {
        //因为是mock出的bookService
        //同时为了将测试范围限定在 controller 层，所以将 service 层的调用固定化
        //相当于 service 层的逻辑没有测试直接返回一个假定的结果
        when(bookService.addBook()).thenReturn("book");
        this.mockMvc.perform(get("/books"))
                .andExpect(status().is(200))
                .andDo(MockMvcResultHandlers.print())
                .andExpect(content().string("book"))
                .andReturn();  
    }
    
}

Test 6-2 full Spring application context

@RunWith(SpringRunner.class)
@SpringBootTest  // 开启 full Spring application context
@AutoConfigureMockMvc //启动自动配置MockMVC
public class BookControllerTest {

    @Autowired
    private MockMvc mockMvc; //只需 autowire
    
    //@MockBean //不需要伪造 一个 bookService bean 因为上下文环境中存在，因为指定了 @SpringBootTest
    //private BookService bookService;
    
    @Autowired  //可以正常注入
    private BookController bookController; 

    
    @Test
    public void testBook2() throws Exception {
        this.mockMvc.perform(get("/books"))
                .andExpect(status().is(200))
                .andDo(MockMvcResultHandlers.print())
                .andExpect(content().string("book"))
                .andReturn();  
    }
    
}

解释

• 当存在 组件 依赖时，如何初始化依赖组件的问题
• @WebMvcTest(SthController.class)，指定的Controller 若需要其它 依赖，必须 @MockBean 伪造一个
• 否则，可用 full Spring Application context

参考：

• http://spring.io/guides/gs/testing-web/
• https://docs.spring.io/spring-boot/docs/current/reference/html/boot-features-testing.html