SpringBoot单元测试

针对不同的代码层次, 有不同的测试注意事项.

我的理解是:

针对Mapper层或者是Dao层,由于需要跟数据库交互, 写完代码的时候手工执行就好, 由于数据库的数据的不稳定性,不适合用作大量回归测试.

针对Service层的单元测试才是我们通常理解的那种单元测试或者说白盒测试.

针对Controller层的测试,如果Mock了Service层的行为,那这个算是白盒测试,如果没有Mock Service层行为,而是直接调用,我觉得其实已经可以算是集成测试了,这个偏向黑盒测试的范畴,就是我们通常说的API测试.

1. 针对Mapper层或者Dao层

如果是有依赖其他Bean对象,可以先写一个专门用来装配Bean的类,并用注解TestConfiguration标注.

当然,这一步也不是必须的,这个只是为了方便在单元测试类中使用@Autowired引入对象.可以在单元测试类中,使用Product product = new Product()代替.

import org.springframework.boot.test.context.TestConfiguration;
import org.springframework.context.annotation.Bean;

import com.windy.mall.product.bean.Product;

@TestConfiguration
public class TestBeanConfiguration {

    @Bean
    public Product createProduct(){
        return new Product();
    }
    
}

单元测试类中必须要声明:

(1) @RunWith(Spring.class),表示要在Spring环境中做测试, 于是就可以使用@Autowired等注解了,

(2) @SpringBootTest(classes=TestBeanConfiguration.class),表示可以使用SpringBoot环境了,这样可以用@Autowired注解,把@Mapper注释过的Mapper对象引入.为了引入外部依赖的Bean对象,需要指定classes=TestBeanConfiguration.class.

注意: 之所以要指定classes=TestBeanConfiguration.class,这时因为Product这个类,并没有使用@Component等注解注入IOC容器.

可选:

(3) @Transactional注解来开启事务

(4) @Rollback(true)表示开启回滚数据功能,默认为True.

import org.junit.Assert;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.annotation.Rollback;
import org.springframework.test.context.junit4.SpringRunner;
import org.springframework.transaction.annotation.Transactional;

import com.windy.mall.product.bean.Product;
import com.windy.mall.product.bean.TestBeanConfiguration;

@RunWith(SpringRunner.class)
@SpringBootTest(classes=TestBeanConfiguration.class)
@Transactional
@Rollback(true)
public class ProductMapperTest {

    @Autowired
    private ProductMapper mapper;
    
    @Autowired
    private Product product;
    
    @Before
    public void setUp(){
        product.setPname("持续交付");
        product.setType("书籍");
        product.setPrice(69d);
    }
    
    @Test
    public void testAdd() {
        Assert.assertEquals(Integer.valueOf(1), mapper.add(product));
    }

}

2. 针对Service层

由于Service层需要调用Mapper层或者是Dao层,通常需要Mock Mapper对象.这里需要使用到@MockBean注解,Mock Mapper层的行为.

package com.windy.mall.product.service;

import org.junit.Assert;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.BDDMockito;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.mock.mockito.MockBean;
import org.springframework.test.context.junit4.SpringRunner;

import com.windy.mall.product.bean.Product;
import com.windy.mall.product.bean.TestBeanConfiguration;
import com.windy.mall.product.mapper.ProductMapper;

@RunWith(SpringRunner.class)
@SpringBootTest(classes = TestBeanConfiguration.class)
public class ProductServiceTest {

    @MockBean
    private ProductMapper mapper;

    @Autowired
    private Product product;

    @Autowired
    private ProductService service;

    @Before
    public void setUp() {
        BDDMockito.given(mapper.add(product)).willReturn(1);
        BDDMockito.given(mapper.add(null)).willReturn(0);
    }

    @Test
    public void testAddService() {
        Assert.assertEquals(Integer.valueOf(1), service.add(product));
        Assert.assertEquals(Integer.valueOf(0), service.add(null));
    }

}

3.针对Controller

有两种方法可以做单元测试:

(1) 这里需要用到web环境(webEnvironment=WebEnvironment.RANDOM_PORT).需要用到TestRestTemplate这个对象作为客户方,调用Controller(API)

import org.junit.Assert;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.context.SpringBootTest.WebEnvironment;
import org.springframework.boot.test.web.client.TestRestTemplate;
import org.springframework.test.context.junit4.SpringRunner;

@RunWith(SpringRunner.class)
@SpringBootTest(webEnvironment=WebEnvironment.RANDOM_PORT)
public class ProductControllerTest {

    @Autowired
    private TestRestTemplate template;
    
    @Test
    public void test() {
        String body = template.getForObject("/ms/product/1", String.class);
        Assert.assertEquals("success", body);
    }

}

(2) 如果是使用MockMVC对象来测试,需要开启@AutoConfigureMockMvc注解

import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;
import org.springframework.test.web.servlet.MockMvc;
import org.springframework.test.web.servlet.request.MockMvcRequestBuilders;
import org.springframework.test.web.servlet.result.MockMvcResultMatchers;

@RunWith(SpringRunner.class)
@SpringBootTest
@AutoConfigureMockMvc
public class ProductControllerTest2 {

    @Autowired
    private MockMvc mvc;

    @Test
    public void test() throws Exception {
        mvc.perform(MockMvcRequestBuilders.get("/ms/product/1"))
                .andExpect(MockMvcResultMatchers.status().isOk())
                .andExpect(MockMvcResultMatchers.content().string("success"));
    }

}