使用OkHttp中的MockWebServer进行接口模拟测试

一、前言

​ 在日常开发中，一般是后台定个接口文档，然后两边开始写代码，写完后开始调试。后台接口问题，或者前端数据和逻辑问题都是在这个过程中进行处理。但是有时候后台因为一些情况进度会慢很多，给前端留出了充足时间，或者有些公司自身的要求，以及开发人员自己精益求精的目的等情况，可以先对整个数据请求过程进行测试，这样也会充分对接口数据的各种情况进行测试。目前来说在网络请求中使用OkHttp的网络框架较多，在这个框架中也提供了接口数据测试的相关依赖，可以进行不同情况的模拟。

二、引入依赖

testImplementation("com.squareup.okhttp3:mockwebserver:4.9.1")

三、使用方式

示例代码如下:

//一个Http网络请求的测试类
class HttpTest {
    @Test
    fun testPost(){
        val mockWebServer = MockWebServer()
        mockWebServer.enqueue(
            MockResponse()
                .setBody(
                    """
                        {
                            code:0,
                            message:"success",
                            data:{
                                age:12,
                                name:"张三"
                            }
                        }
                    """.trimIndent()
                )
        )
        mockWebServer.start()
        val mockWebServerUrl = mockWebServer.url("/post")
        val url = "http://${mockWebServerUrl.host}:${mockWebServer.port}"
        println("网络请求:$url")
        OkHttpUtil.postFrom()
            .url(url)
            .build()
            .execute(object : SerialPortHttpCallBack<UserModel>(){
                override fun onError(call: Call?, e: Exception?, id: Int) {
                    e?.printStackTrace()
                }

                override fun onResponse(response: HttpBaseResponseMode<UserModel>?, id: Int) {
                    if (response?.code != 0){
                        return
                    }
                    val data = response.data
                    println("解析的结果:${data?.name}")
                }
            })
        Thread.sleep(5*1000)
    }
}

四、注意事项

1. 请求地址，因为数据的模拟的，所以请求地址也需要是mockwebserver的地址，如果使用的是URL对象进行，可以直接使用mockWebServer.url("/post")进行获取URL对象进行访问，但是如果是使用String的方式访问的话，需要使用以下方式：

   val url = "http://${mockWebServerUrl.host}:${mockWebServer.port}${mockWebServerUrl.encodedPath}"

   得到的内容为：

   http://127.0.0.1:56020/post

   至此可以将模拟的数据和自己封装的网络请求代码进行分离

2. 测试代码运行在../app/src/test/java/<packageName>/ExampleUnitTest.kt中，也可以自己创建一个文件。

3. 由于测试代码其实没有运行在Android环境中，所以关于Android的一些代码是不能使用的，例如Log日志代码，因此需要进行注意一下。

4. 由于是测试代码，所以任务执行完后，程序就结束了，所以如果是异步线程的话，需要使用Thread.sleep(5*1000)稍微将运行时间延迟一下。

五、参考链接

1. okhttp的参考：okhttp/mockwebserver at master · square/okhttp · GitHub https://github.com/square/okhttp/tree/master/mockwebserver
2. OkHttp3系列（二）MockWebServer使用：OkHttp3系列（二）MockWebServer使用 - weegee - 博客园 (cnblogs.com)
   https://www.cnblogs.com/weegee/p/13410049.html