單元測試：單元測試中的mock
阿新 • • 發佈：2021-01-20
公司要求提升單元測試的質量，提高程式碼的分支覆蓋率和行覆蓋率，安排我研究單元測試，指定方案分享並在開發部普及開。整理完資料後，同步一下到部落格。
## 單元測試中的mock的目的
mock的主要目的是讓單元測試**Write Once, Run Everywhere**,即編寫一次後，可以在任意時刻任意環境執行，無需依賴資料庫網路等。
## Mock工具介紹
Mock工具經過調研，基本上是表格下面的這麼個情況:
| mockserver方案 | 開源 | 支援隨機引數 | 支援請求延時模擬 | 支援引數上下文 | 倉庫分組 | 介面管理 | 儀表盤 | 日誌 | 支援管理臺配置 | 支援程式設計 |
| ---- | ---- | ---- | ---- | ---- | ---- | ---- | ---- | ---- | ---- | ---- |
| rap2，easy-mock等 | 是 | 是 | 否 | 否 | 是 | 是 | 否 | 否 | 是 | 是 |
| wiremock | 是 | 否 | 是 | 否 | 否 | 否 | 否 | 是 | 否 | 是 |
| mock-server | 是 | 是 | 是 | 是 | 是 | 否 | 否 | 是 | 否 | 是 |
| postman | 否 | 否 | 否 | 否 | 否 | 否 | 否 | 否 | 否 | 否 |
簡要介紹下各個的特點和為什麼沒選：
1. rap2和easy-mock等，都是基於node開發的，和我們開發部的主力語言Java相性一般，後續改造難度大，並且不支援請求超時的配置和上下文的配置，優點是使用操作簡單，pass。
2. wiremock，和rap2差不多，就是多個支援延時請求，不過是英文的，pass
3. mock-server，基於java語言的，底層是netty，程式設計自由，比較適合java技術棧的團隊。
4. postman，雖然有mock功能，但是隻能針對某個請求的返回固定mock，並且每次啟動mock的埠和url完全隨機，無法接受，pass。
我們最後選的是mockito和mock-server，mockito因為是java的mock工具包，所以並不在上面的表格裡。
### mockito
#### 相關介紹：
這個包是spring官方也推薦的mock依賴，在spring-boot-starter-test中預設就會自動包含。
這個包提供的相關類，主要功能就是對某個物件進行mock，通過其提供的特殊的語法，對某個物件的返回以及行為做mock。
#### 應用場景：
單元測試時，如果依賴其他系統的RPC呼叫（比如feign或dubbo），可以針對相關RPC的呼叫物件進行直接mock，直接返回成功、超時、異常，減少依賴。
在對系統內部的某些工具類或者資料庫層進行單元測試時，可以模擬一些異常情況，比如資料庫超時、框架層丟擲某些很難復現的特定異常返回，可以通過直接mock實現來達到效果。
mockito除了mock外也支援spy，mock與spy的區別是，mock產生的是一個空物件，對mock物件未做配置的方法呼叫均返回null或異常。spy產生的是一個代理物件，對那些做了配置的方法按照配置的預期返回，未做配置的方法直接會呼叫原方法。
#### 使用方式（spring）：
1. maven中引入：
```xml
org.mockito
mockito-all
1.9.5
test
```
2. 在測試類中進行如下定義：
```java
//需要mock的服務，一般是RPC，也可以是工具類，總而言之是一個物件
@Mock
TestRpc testRpc;
@Autowired
TestService testService;
//在@Before中對其進行初始化
@Before
public void initMocks() throws Exception {
//1.1 初始化的api，在這一步執行後，testRpc被初始化為一個mock物件
MockitoAnnotations.initMocks(this);
//1.2 使用mock物件替換spring中的bean：這裡是將後面要用到的testService中的testRpc這個rpc物件，
//替換為上面@Mock為我們建立的mock物件，然後我們就可以對這個物件進行mock了，這裡的替換是spring容器級別的替換
//注意，理論上對RPC的service進行mock即可，即替換呼叫RPC的那個bean中的rpc物件。
ReflectionTestUtils.setField(AopTargetUtils.getTarget(orderPayFacade), "testRpc", testRpc);
//1.3 定義mock返回：對新的mock物件進行定義，當後續請求這個rpc的該方法時，會直接return一個空的成功物件
final ResultRpc testVo = new ResultRpc<>();
when(testRpc.getAccountByBindCardId("101010")).thenReturn(testVo);
}
```
或者
```java
//另一種初始化方式，更加簡單快捷
//這裡是另一種寫法，設定一個預設的answer，不用每個方法都設定一次返回,也可以繼續進行上面那種方式的when配置
final TestRpc testRpcMock = mock(TestRpc.class, new Answer() {
@Override
public TestRes answer(InvocationOnMock invocationOnMock) throws Throwable {
final TestRes testRes = new TestRes();
testRes.setConfigId(0L);
testRes.setCityId(86);
testRes.setServiceId("01");
testRes.setSysJoinType(0);
testRes.setMerchantId("320212018002");
testRes.setMerchantCode("");
return testRes;
}
});
ReflectionTestUtils.setField(AopTargetUtils.getTarget(testService), "testRpc", testRpcMock);
```
3. 然後直接正常執行測試即可。
#### 使用方式（spring-boot及以上）：
前面說了spring-boot-starter較高版本（2.0以上）的test中預設會包括該依賴，所以直接使用就行，更方便的是無需使用反射工具替換spring上下文的bean，使用@MockBean註解標識bean即可。
### mock-server
#### 相關資料：
官方文件https://www.mock-server.com/
#### 應用場景：
當進行單元測試時，如果我們需要進行http請求級別的模擬以及mock，那麼我們就可以使用mockserver
當然mockito也可以通過直接mock那些http請求的類來達到相似效果，不過使用mock-server，我們可以更逼真的模擬http的環境，以提前發現那些只有在使用網路下才會出現的問題。
既可以整合在maven的test生命週期裡，也可以直接單獨啟動做一個server。
#### 使用方式：
1. maven中引入：
```xml
org.mock-server 5.11.1
```
2. 在測試類中進行如下定義：
```java
private final int mockPort = 19999;
private ClientAndServer mockServer;
//在@Before中對其進行初始化
@Before
public void initMocks() throws Exception {
//1.1 初始化的api：啟動mockserver
mockServer = startClientAndServer(mockPort);
//1.2 配置mockServer
mockServer
.when(
request()
.withMethod("POST")
.withPath("/test/pay_v1/trade/pay")
.withContentType(MediaType.APPLICATION_JSON)
)
.respond(
new TestResponseCallBack()
);
}
public static class TestResponseCallBack implements ExpectationResponseCallback{
private final Gson gson=new Gson();
@Override
public HttpResponse handle(HttpRequest httpRequest) throws Exception {
log.info("------------{}",httpRequest);
if (httpRequest.getMethod().getValue().equals("POST")) {
//校驗簽名
boolean verify = doVerifySign(httpRequest);
if (!verify){
return response()
.withStatusCode(OK_200.code())
.withBody(gson.toJson(CommonResult.failure(CommonErrors.SIGNATURE_VERIFY_FAIL)));
}
//構造返回
return createResponse(httpRequest);
} else {
return notFoundResponse();
}
}
private HttpResponse createResponse(HttpRequest httpRequest) throws Exception {
final HttpRequest httpRequest1 = httpRequest;
final String req = new String(httpRequest.getBodyAsRawBytes());
String respBody="";
final JSONObject jsonObject= JSON.parseObject(req);
//比如對引數做一些校驗
Assert.assertNotNull(jsonObject.getString("user_id"));
//構造返回，可以根據請求的內容構造，這裡隨便寫個返回，
final String user_id = jsonObject.getString("user_id");
respBody="{\"success\": true,\"errcode\": \"0000\",\"errmsg\": \"成功\",\"result\": {\"user_id\": \"123456\",\"reserved\":"+user_id+"\"\"}}";
//這裡如果必要的話，也可以觸發一個延時的回撥
new Thread(new Runnable() {
@Override
public void run() {
LockSupport.parkNanos(1000000000L*2);
final String notify_url = jsonObject.getString("notify_url");
HttpHeaders headers = new HttpHeaders();
headers.setContentType(org.springframework.http.MediaType.APPLICATION_JSON);
headers.add("Accept", MediaType.APPLICATION_JSON.toString());
JSONObject param = new JSONObject();
param.put("username", "123");
HttpEntity formEntity = new HttpEntity(param.toJSONString(), headers);
String result = new RestTemplate().postForObject(notify_url, formEntity, String.class);
log.info("傳送回撥：{}",param.toJSONString());
}
}).start();
return response()
.withStatusCode(OK_200.code())
.withBody(respBody);
}
private boolean doVerifySign(HttpRequest httpRequest) throws Exception {
String signature = httpRequest.getFirstHeader(RequestHeader.Signature);
String message = new String(httpRequest.getBodyAsRawBytes(), StandardCharsets.UTF_8);
String md5HexMessage = DigestUtils.md5Hex(message.getBytes(StandardCharsets.UTF_8));
return RSAUtils.doCheck(md5HexMessage, signature, privateKey, StandardCharsets.UTF_8.displayName());
}
}
```
3. 然後直接正常執行測試即可。
### cobertura-maven-plugin
前面的2個mock工具，結合cobertura-maven-plugin，可以瞬間跑起一個帶程式碼覆蓋率的測試。
#### 使用方式：
1. maven
```xml
org.codehaus.mojo 2.7
```
2. 執行測試：mvn clean cobertura:cobertura -f pom.xml
3. 到target/site下開啟index檔案檢視結果:
### 總結
本人簡單介紹了3個工具的使用，主要是提供了一個可行的方案去推進單元測試，具體3個工具的詳細使用細節以及進階，可以自行查詢資料。