公司要求提高單元測試的質量,提升代碼的分支覆蓋率和行覆蓋率,安排我研究單元測試,指定方案分享並在開發部普及開。整理完資料後,同步一下到博客。java
mock的主要目的是讓單元測試Write Once, Run Everywhere,即編寫一次後,能夠在任意時刻任意環境運行,無需依賴數據庫網絡等。node
Mock工具通過調研,基本上是表格下面的這麼個狀況:spring
mockserver方案 | 開源 | 支持隨機參數 | 支持請求延時模擬 | 支持參數上下文 | 倉庫分組 | 接口管理 | 儀表盤 | 日誌 | 支持管理臺配置 | 支持編程 |
---|---|---|---|---|---|---|---|---|---|---|
rap2,easy-mock等 | 是 | 是 | 否 | 否 | 是 | 是 | 否 | 否 | 是 | 是 |
wiremock | 是 | 否 | 是 | 否 | 否 | 否 | 否 | 是 | 否 | 是 |
mock-server | 是 | 是 | 是 | 是 | 是 | 否 | 否 | 是 | 否 | 是 |
postman | 否 | 否 | 否 | 否 | 否 | 否 | 否 | 否 | 否 | 否 |
簡要介紹下各個的特色和爲何沒選:數據庫
咱們最後選的是mockito和mock-server,mockito由於是java的mock工具包,因此並不在上面的表格裏。編程
這個包是spring官方也推薦的mock依賴,在spring-boot-starter-test中默認就會自動包含。
這個包提供的相關類,主要功能就是對某個對象進行mock,經過其提供的特殊的語法,對某個對象的返回以及行爲作mock。json
單元測試時,若是依賴其餘系統的RPC調用(好比feign或dubbo),能夠針對相關RPC的調用對象進行直接mock,直接返回成功、超時、異常,減小依賴。
在對系統內部的某些工具類或者數據庫層進行單元測試時,能夠模擬一些異常狀況,好比數據庫超時、框架層拋出某些很難復現的特定異常返回,能夠經過直接mock實現來達到效果。
mockito除了mock外也支持spy,mock與spy的區別是,mock產生的是一個空對象,對mock對象未作配置的方法調用均返回null或異常。spy產生的是一個代理對象,對那些作了配置的方法按照配置的預期返回,未作配置的方法直接會調用原方法。api
<dependency> <groupId>org.mockito</groupId> <artifactId>mockito-all</artifactId> <version>1.9.5</version> <scope>test</scope> </dependency>
//須要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> testVo = new ResultRpc<>(); when(testRpc.getAccountByBindCardId("101010")).thenReturn(testVo); }
或者網絡
//另外一種初始化方式,更加簡單快捷 //這裏是另外一種寫法,設置一個默認的answer,不用每一個方法都設置一次返回,也能夠繼續進行上面那種方式的when配置 final TestRpc testRpcMock = mock(TestRpc.class, new Answer<TestRes>() { @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);
前面說了spring-boot-starter較高版本(2.0以上)的test中默認會包括該依賴,因此直接使用就行,更方便的是無需使用反射工具替換spring上下文的bean,使用@MockBean註解標識bean便可。框架
官方文檔https://www.mock-server.com/maven
當進行單元測試時,若是咱們須要進行http請求級別的模擬以及mock,那麼咱們就可使用mockserver
固然mockito也能夠經過直接mock那些http請求的類來達到類似效果,不過使用mock-server,咱們能夠更逼真的模擬http的環境,以提早發現那些只有在使用網絡下才會出現的問題。
既能夠集成在maven的test生命週期裏,也能夠直接單獨啓動作一個server。
<dependency> <groupId>org.mock-server</groupId> <artifactId>mockserver-netty</artifactId> <version>5.11.1</version> </dependency>
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<String> formEntity = new HttpEntity<String>(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()); } }
前面的2個mock工具,結合cobertura-maven-plugin,能夠瞬間跑起一個帶代碼覆蓋率的測試。
<plugin> <groupId>org.codehaus.mojo</groupId> <artifactId>cobertura-maven-plugin</artifactId> <version>2.7</version> </plugin>
本人簡單介紹了3個工具的使用,主要是提供了一個可行的方案去推動單元測試,具體3個工具的詳細使用細節以及進階,能夠自行查找資料。