使用Mockito測試Callback回調(diào),你學(xué)會了嗎?
概述
在這個簡短的教程中,我們將重點介紹如何使用流行的測試框架Mockito測試回調(diào)。
我們將探索兩種解決方案,首先使用ArgumentCaptor,然后使用直觀的doAnswer()方法。
Callback回調(diào)簡介
Callback回調(diào)函數(shù)是作為參數(shù)傳遞給方法,該方法應(yīng)在給定時間執(zhí)行回調(diào)參數(shù)。
使用回調(diào)的一個常見場景是在服務(wù)交互期間,當(dāng)我們需要處理來自服務(wù)調(diào)用的響應(yīng)時。比如:
public interface Service {
void doAction(String request, Callback<Response> callback);
}
在回調(diào)參數(shù)中,我們傳遞一個類,該類將使用reply(T response)方法處理響應(yīng):
public interface Callback<T> {
void reply(T response);
}
我們將使用一個簡單的服務(wù)示例來演示如何傳遞和調(diào)用回調(diào):
public void doAction() {
service.doAction("our-request", new Callback<Response>() {
@Override
public void reply(Response response) {
handleResponse(response);
}
});
}
private void handleResponse(Response response) {
if (response.isValid()) {
response.setData(new Data("Successful data response"));
}
}
我們選擇使用Java Lamda表達式寫得更簡潔:
service.doAction("our-request", response -> handleResponse(response));
使用ArgumentCaptor
現(xiàn)在,讓我們看看Mockito如何使用ArgumentCaptor來獲取回調(diào)對象:
@Test
public void givenServiceWithValidResponse_whenCallbackReceived_thenProcessed() {
ActionHandler handler = new ActionHandler(service);
handler.doAction();
verify(service).doAction(anyString(), callbackCaptor.capture());
Callback<Response> callback = callbackCaptor.getValue();
Response response = new Response();
callback.reply(response);
String expectedMessage = "Successful data response";
Data data = response.getData();
assertEquals(
"Should receive a successful message: ",
expectedMessage, data.getMessage());
}
在本例中,我們首先創(chuàng)建一個ActionHandler,然后調(diào)用該處理程序的doAction方法。這只是service.doAction方法調(diào)用的包裝器,我們在這里調(diào)用回調(diào)。
接下來,我們驗證doAction是否在mock服務(wù)實例上被調(diào)用,并將anyString()作為第一個參數(shù),將callbackCaptor.capture()作為第二個參數(shù),這就是我們捕獲回調(diào)對象的地方。然后可以使用getValue()方法返回參數(shù)的捕獲值。
現(xiàn)在我們有了回調(diào)對象,創(chuàng)建一個默認(rèn)有效的Response對象,直接調(diào)用reply方法并斷言響應(yīng)數(shù)據(jù)具有正確值。
使用doAnswer()方法
現(xiàn)在,我們將使用Mockito的Answer對象和doAnswer方法來存根void方法doAction:
@Test
public void givenServiceWithInvalidResponse_whenCallbackReceived_thenNotProcessed() {
Response response = new Response();
response.setIsValid(false);
doAnswer((Answer<Void>) invocation -> {
Callback<Response> callback = invocation.getArgument(1);
callback.reply(response);
Data data = response.getData();
assertNull("No data in invalid response: ", data);
return null;
}).when(service)
.doAction(anyString(), any(Callback.class));
ActionHandler handler = new ActionHandler(service);
handler.doAction();
}
在第二個示例中,我們首先創(chuàng)建一個無效的Response對象,該對象將在稍后的測試中使用。
接下來,我們在mock服務(wù)上設(shè)置Answer,以便在調(diào)用doAction時,我們攔截調(diào)用并使用invocation.getArgument(1)獲取方法參數(shù)以獲取回調(diào)參數(shù)。
最后一步是創(chuàng)建ActionHandler并調(diào)用doAction,從而調(diào)用Answer。
結(jié)論
本文介紹了在使用Mockito進行測試時處理測試回調(diào)的兩種不同方法,相比較使用doAnswer方式比較直觀。