SpringBoot 單元測試與 Mockito 使用
單元測試應(yīng)遵循 → AIR 原則
SpringBoot 測試支持由兩個模塊提供:
- spring-boot-test 包含核心項目
- spring-boot-test-autoconfigure 支持測試的自動配置
通常我們只要引入 spring-boot-starter-test
依賴就行心软,它包含了一些常用的模塊 Junit颗管、Spring Test、AssertJ玫芦、Hamcrest、Mockito 等茂契。
相關(guān)注解
SpringBoot 使用了 Junit4 作為單元測試框架饮亏,所以注解與 Junit4 是一致的。
注解 | 作用 |
---|---|
@Test(excepted==xx.class,timeout=毫秒數(shù)) | 修飾一個方法為測試方法忠藤,excepted參數(shù)可以忽略某些異常類 |
@Before | 在每一個測試方法被運行前執(zhí)行一次 |
@BeforeClass | 在所有測試方法執(zhí)行前執(zhí)行 |
@After | 在每一個測試方法運行后執(zhí)行一次 |
@AfterClass | 在所有測試方法執(zhí)行后執(zhí)行 |
@Ignore | 修飾的類或方法會被測試運行器忽略 |
@RunWith | 更改測試運行器 |
@SpringBootTest
SpringBoot提供了一個 @SpringBootTest 注解用于測試 SpringBoot 應(yīng)用挟伙,它可以用作標準 spring-test @ContextConfiguration 注釋的替代方法,其原理是通過 SpringApplication 在測試中創(chuàng)建ApplicationContext模孩。
@RunWith(SpringRunner.class)
@SpringBootTest
public class ApplicationTest {
}
該注解提供了兩個屬性用于配置:
-
webEnvironment:指定Web應(yīng)用環(huán)境尖阔,它可以是以下值
- MOCK:提供一個模擬的 Servlet 環(huán)境,內(nèi)置的 Servlet 容器沒有啟動榨咐,配合可以與@AutoConfigureMockMvc 結(jié)合使用介却,用于基于 MockMvc 的應(yīng)用程序測試。
- RANDOM_PORT:加載一個 EmbeddedWebApplicationContext 并提供一個真正嵌入式的 Servlet 環(huán)境块茁,隨機端口筷笨。
- DEFINED_PORT:加載一個 EmbeddedWebApplicationContext 并提供一個真正嵌入式的 Servlet 環(huán)境,默認端口 8080 或由配置文件指定龟劲。
- NONE:使用 SpringApplication 加載 ApplicationContext胃夏,但不提供任何 servlet 環(huán)境。
- classes:指定應(yīng)用啟動類昌跌,通常情況下無需設(shè)置仰禀,因為 SpringBoot 會自動搜索,直到找到 @SpringBootApplication 或 @SpringBootConfiguration 注解蚕愤。
單元測試回滾
如果你添加了 @Transactional 注解答恶,它會在每個測試方法結(jié)束時會進行回滾操作。
但是如果使用 RANDOM_PORT 或 DEFINED_PORT 這種真正的 Servlet 環(huán)境萍诱,HTTP 客戶端和服務(wù)器將在不同的線程中運行悬嗓,從而分離事務(wù)。 在這種情況下裕坊,在服務(wù)器上啟動的任何事務(wù)都不會回滾包竹。
斷言
JUnit4 結(jié)合 Hamcrest 提供了一個全新的斷言語法——assertThat
,結(jié)合 Hamcrest 提供的匹配符,就可以表達全部的測試思想周瞎。
// 一般匹配符
int s = new C().add(1, 1);
// allOf:所有條件必須都成立苗缩,測試才通過
assertThat(s, allOf(greaterThan(1), lessThan(3)));
// anyOf:只要有一個條件成立,測試就通過
assertThat(s, anyOf(greaterThan(1), lessThan(1)));
// anything:無論什么條件声诸,測試都通過
assertThat(s, anything());
// is:變量的值等于指定值時酱讶,測試通過
assertThat(s, is(2));
// not:和is相反,變量的值不等于指定值時彼乌,測試通過
assertThat(s, not(1));
// 數(shù)值匹配符
double d = new C().div(10, 3);
// closeTo:浮點型變量的值在3.0±0.5范圍內(nèi)泻肯,測試通過
assertThat(d, closeTo(3.0, 0.5));
// greaterThan:變量的值大于指定值時,測試通過
assertThat(d, greaterThan(3.0));
// lessThan:變量的值小于指定值時慰照,測試通過
assertThat(d, lessThan(3.5));
// greaterThanOrEuqalTo:變量的值大于等于指定值時灶挟,測試通過
assertThat(d, greaterThanOrEqualTo(3.3));
// lessThanOrEqualTo:變量的值小于等于指定值時,測試通過
assertThat(d, lessThanOrEqualTo(3.4));
// 字符串匹配符
String n = new C().getName("Magci");
// containsString:字符串變量中包含指定字符串時焚挠,測試通過
assertThat(n, containsString("ci"));
// startsWith:字符串變量以指定字符串開頭時膏萧,測試通過
assertThat(n, startsWith("Ma"));
// endsWith:字符串變量以指定字符串結(jié)尾時,測試通過
assertThat(n, endsWith("i"));
// euqalTo:字符串變量等于指定字符串時蝌衔,測試通過
assertThat(n, equalTo("Magci"));
// equalToIgnoringCase:字符串變量在忽略大小寫的情況下等于指定字符串時榛泛,測試通過
assertThat(n, equalToIgnoringCase("magci"));
// equalToIgnoringWhiteSpace:字符串變量在忽略頭尾任意空格的情況下等于指定字符串時,測試通過
assertThat(n, equalToIgnoringWhiteSpace(" Magci "));
// 集合匹配符
List<String> l = new C().getList("Magci");
// hasItem:Iterable變量中含有指定元素時噩斟,測試通過
assertThat(l, hasItem("Magci"));
Map<String, String> m = new C().getMap("mgc", "Magci");
// hasEntry:Map變量中含有指定鍵值對時曹锨,測試通過
assertThat(m, hasEntry("mgc", "Magci"));
// hasKey:Map變量中含有指定鍵時,測試通過
assertThat(m, hasKey("mgc"));
// hasValue:Map變量中含有指定值時剃允,測試通過
assertThat(m, hasValue("Magci"));
基本的單元測試例子
下面是一個基本的單元測試例子沛简,對某個方法的返回結(jié)果進行斷言:
@Service
public class UserService {
public String getName() {
return "lyTongXue";
}
}
@RunWith(SpringRunner.class)
@SpringBootTest
public class UserServiceTest {
@Autowired
private UserService service;
@Test
public void getName() {
String name = service.getName();
assertThat(name,is("lyTongXue"));
}
}
Controller 測試
Spring 提供了 MockMVC 用于支持 RESTful 風(fēng)格的 Spring MVC 測試,使用 MockMvcBuilder 來構(gòu)造MockMvc 實例斥废。MockMvc 有兩個實現(xiàn):
-
StandaloneMockMvcBuilder:指定 WebApplicationContext椒楣,它將會從該上下文獲取相應(yīng)的控制器并得到相應(yīng)的 MockMvc
@RunWith(SpringRunner.class) @SpringBootTest public class UserControllerTest { @Autowired private WebApplicationContext webApplicationContext; private MockMvc mockMvc; @Before public void setUp() throws Exception { mockMvc = MockMvcBuilders.webAppContextSetup(webApplicationContext).build(); }
-
DefaultMockMvcBuilder:通過參數(shù)指定一組控制器,這樣就不需要從上下文獲取了
@RunWith(SpringRunner.class) @SpringBootTest public class UserControllerTest { private MockMvc mockMvc; @Before public void setUp() throws Exception { mockMvc = MockMvcBuilders.standaloneSetup(new UserController()).build(); } }
下面是一個簡單的用例牡肉,對 UserController 的 /v1/users/{id}
接口進行測試捧灰。
@RestController
@RequestMapping("v1/users")
public class UserController {
@GetMapping("/{id}")
public User get(@PathVariable("id") String id) {
return new User(1, "lyTongXue");
}
@Data
@AllArgsConstructor
public class User {
private Integer id;
private String name;
}
}
// ...
import static org.hamcrest.Matchers.containsString;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
@RunWith(SpringRunner.class)
@SpringBootTest
public class UserControllerTest {
@Autowired
private WebApplicationContext webApplicationContext;
private MockMvc mockMvc;
@Before
public void setUp() {
mockMvc = MockMvcBuilders.webAppContextSetup(webApplicationContext).build();
}
@Test
public void getUser() {
mockMvc.perform(get("/v1/users/1")
.accept(MediaType.APPLICATION_JSON_UTF8))
.andExpect(status().isOk())
.andExpect(content().string(containsString("\"name\":\"lyTongXue\"")));
}
}
方法描述
perform:執(zhí)行一個 RequestBuilder 請求,返回一個 ResultActions 實例對象统锤,可對請求結(jié)果進行期望與其它操作
get:聲明發(fā)送一個 get 請求的方法毛俏,更多的請求類型可查閱→MockMvcRequestBuilders 文檔
andExpect:添加 ResultMatcher 驗證規(guī)則,驗證請求結(jié)果是否正確饲窿,驗證規(guī)則可查閱→MockMvcResultMatchers 文檔
andDo:添加 ResultHandler 結(jié)果處理器煌寇,比如調(diào)試時打印結(jié)果到控制臺,更多處理器可查閱→MockMvcResultHandlers 文檔
andReturn:返回執(zhí)行請求的結(jié)果逾雄,該結(jié)果是一個恩 MvcResult 實例對象→MvcResult 文檔
Mock 數(shù)據(jù)
在單元測試中阀溶,Service 層的調(diào)用往往涉及到對數(shù)據(jù)庫腻脏、中間件等外部依賴。而在單元測試 AIR 原則中淌哟,單元測試應(yīng)該是可以重復(fù)執(zhí)行的迹卢,不應(yīng)受到外界環(huán)境的影響的辽故。此時我們可以通過 Mock 一個實現(xiàn)來處理這種情況徒仓。
如果不需要對靜態(tài)方法,私有方法等特殊進行驗證測試誊垢,則僅僅使用 Spring boot 自帶的 Mockito 即可完成相關(guān)的測試數(shù)據(jù) Mock掉弛。若需要則可以使用 PowerMock,簡單實用喂走,結(jié)合 Spring 可以使用注解注入殃饿。
@MockBean
SpringBoot 在執(zhí)行單元測試時,會將該注解的 Bean 替換掉 IOC 容器中原生 Bean芋肠。
例如下面代碼中乎芳, ProjectService 中通過 ProjectMapper 的 selectById 方法進行數(shù)據(jù)庫查詢操作:
@Service
public class ProjectService {
@Autowired
private ProjectMapper mapper;
public ProjectDO detail(String id) {
return mapper.selectById(id);
}
}
此時我們可以對 Mock 一個 ProjectMapper 對象替換掉 IOC 容器中原生的 Bean,來模擬數(shù)據(jù)庫查詢操作帖池,如:
@RunWith(SpringRunner.class)
@SpringBootTest
public class ProjectServiceTest {
@MockBean
private ProjectMapper mapper;
@Autowired
private ProjectService service;
@Test
public void detail() {
ProjectDemoDO model = new ProjectDemoDO();
model.setId("1");
model.setName("dubbo-demo");
Mockito.when(mapper.selectById("1")).thenReturn(model);
ProjectDemoDO entity = service.detail("1");
assertThat(entity.getName(), containsString("dubbo-demo"));
}
}
Mockito 常用方法
Mockito 更多的使用可查看→官方文檔
mock() 對象
List list = mock(List.class);
verify() 驗證互動行為
@Test
public void mockTest() {
List list = mock(List.class);
list.add(1);
// 驗證 add(1) 互動行為是否發(fā)生
Mockito.verify(list).add(1);
}
when() 模擬期望結(jié)果
@Test
public void mockTest() {
List list = mock(List.class);
when(mock.get(0)).thenReturn("hello");
assertThat(mock.get(0),is("hello"));
}
doThrow() 模擬拋出異常
@Test(expected = RuntimeException.class)
public void mockTest(){
List list = mock(List.class);
doThrow(new RuntimeException()).when(list).add(1);
list.add(1);
}
@Mock 注解
在上面的測試中我們在每個測試方法里都 mock
了一個 List 對象奈惑,為了避免重復(fù)的 mock
,使測試類更具有可讀性睡汹,我們可以使用下面的注解方式來快速模擬對象:
// @RunWith(MockitoJUnitRunner.class)
public class MockitoTest {
@Mock
private List list;
public MockitoTest(){
// 初始化 @Mock 注解
MockitoAnnotations.initMocks(this);
}
@Test
public void shorthand(){
list.add(1);
verify(list).add(1);
}
}
when() 參數(shù)匹配
@Test
public void mockTest(){
Comparable comparable = mock(Comparable.class);
//預(yù)設(shè)根據(jù)不同的參數(shù)返回不同的結(jié)果
when(comparable.compareTo("Test")).thenReturn(1);
when(comparable.compareTo("Omg")).thenReturn(2);
assertThat(comparable.compareTo("Test"),is(1));
assertThat(comparable.compareTo("Omg"),is(2));
//對于沒有預(yù)設(shè)的情況會返回默認值
assertThat(list.get(1),is(999));
assertThat(comparable.compareTo("Not stub"),is(0));
}
Answer 修改對未預(yù)設(shè)的調(diào)用返回默認期望
@Test
public void mockTest(){
//mock對象使用Answer來對未預(yù)設(shè)的調(diào)用返回默認期望值
List list = mock(List.class,new Answer() {
@Override
public Object answer(InvocationOnMock invocation) throws Throwable {
return 999;
}
});
//下面的get(1)沒有預(yù)設(shè)肴甸,通常情況下會返回NULL,但是使用了Answer改變了默認期望值
assertThat(list.get(1),is(999));
//下面的size()沒有預(yù)設(shè)囚巴,通常情況下會返回0原在,但是使用了Answer改變了默認期望值
assertThat(list.size(),is(999));
}
spy() 監(jiān)控真實對象
Mock 不是真實的對象,它只是創(chuàng)建了一個虛擬對象彤叉,并可以設(shè)置對象行為庶柿。而 Spy是一個真實的對象,但它可以設(shè)置對象行為秽浇。
@Test(expected = IndexOutOfBoundsException.class)
public void mockTest(){
List list = new LinkedList();
List spy = spy(list);
//下面預(yù)設(shè)的spy.get(0)會報錯浮庐,因為會調(diào)用真實對象的get(0),所以會拋出越界異常
when(spy.get(0)).thenReturn(3);
//使用doReturn-when可以避免when-thenReturn調(diào)用真實對象api
doReturn(999).when(spy).get(999);
//預(yù)設(shè)size()期望值
when(spy.size()).thenReturn(100);
//調(diào)用真實對象的api
spy.add(1);
spy.add(2);
assertThat(spy.size(),is(100));
assertThat(spy.size(),is(1));
assertThat(spy.size(),is(2));
verify(spy).add(1);
verify(spy).add(2);
assertThat(spy.get(999),is(999));
}
reset() 重置 mock
@Test
public void reset_mock(){
List list = mock(List.class);
when(list.size()).thenReturn(10);
list.add(1);
assertThat(list.size(),is(10));
//重置mock兼呵,清除所有的互動和預(yù)設(shè)
reset(list);
assertThat(list.size(),is(0));
}
times() 驗證調(diào)用次數(shù)
@Test
public void verifying_number_of_invocations(){
List list = mock(List.class);
list.add(1);
list.add(2);
list.add(2);
list.add(3);
list.add(3);
list.add(3);
//驗證是否被調(diào)用一次兔辅,等效于下面的times(1)
verify(list).add(1);
verify(list,times(1)).add(1);
//驗證是否被調(diào)用2次
verify(list,times(2)).add(2);
//驗證是否被調(diào)用3次
verify(list,times(3)).add(3);
//驗證是否從未被調(diào)用過
verify(list,never()).add(4);
//驗證至少調(diào)用一次
verify(list,atLeastOnce()).add(1);
//驗證至少調(diào)用2次
verify(list,atLeast(2)).add(2);
//驗證至多調(diào)用3次
verify(list,atMost(3)).add(3);
}
inOrder() 驗證執(zhí)行順序
@Test
public void verification_in_order(){
List list = mock(List.class);
List list2 = mock(List.class);
list.add(1);
list2.add("hello");
list.add(2);
list2.add("world");
//將需要排序的mock對象放入InOrder
InOrder inOrder = inOrder(list,list2);
//下面的代碼不能顛倒順序,驗證執(zhí)行順序
inOrder.verify(list).add(1);
inOrder.verify(list2).add("hello");
inOrder.verify(list).add(2);
inOrder.verify(list2).add("world");
}
verifyZeroInteractions() 驗證零互動行為
@Test
public void mockTest(){
List list = mock(List.class);
List list2 = mock(List.class);
List list3 = mock(List.class);
list.add(1);
verify(list).add(1);
verify(list,never()).add(2);
//驗證零互動行為
verifyZeroInteractions(list2,list3);
}
verifyNoMoreInteractions() 驗證冗余互動行為
@Test(expected = NoInteractionsWanted.class)
public void mockTest(){
List list = mock(List.class);
list.add(1);
list.add(2);
verify(list,times(2)).add(anyInt());
//檢查是否有未被驗證的互動行為击喂,因為add(1)和add(2)都會被上面的anyInt()驗證到维苔,所以下面的代碼會通過
verifyNoMoreInteractions(list);
List list2 = mock(List.class);
list2.add(1);
list2.add(2);
verify(list2).add(1);
//檢查是否有未被驗證的互動行為,因為add(2)沒有被驗證懂昂,所以下面的代碼會失敗拋出異常
verifyNoMoreInteractions(list2);
}