Android中使用MockWebServer测试API

文/ZYRzyr
原文链接:http://www.jianshu.com/p/e906f7ee2a04

本文适合这几类同学阅读：熟悉使用Junit4、okhttp与retrofit的，闲着无聊的。
  Android中有关网络的开发通常伴随着整个应用的开发过程，而在这个过程中，大多数都是采用的手动测试，即运行在真机或模拟器中进行真实的网络连接测试，这样做难免会浪费一些时间。但若应用中使用的是okhttp，则有一个非常方便省时的办法，即使用MockWebServer进行单元测试。
  本文将使用MockWebServer并结合retrofit，介绍Android中网络部分的单元测试。

一.准备

在此，默认已在工程中使用了okhttp与retrofit，接下来，在Module的build.gradle中引入MockWebServer:

dependencies {
    testCompile 'com.squareup.okhttp3:mockwebserver:3.8.1'  //本文编写时的最新版本
}

二.开始测试

1.新建测试文件WebTest.java:

@RunWith(JUnit4.class)
public class WebTest {

}

2.声明并实例化MockWebServer:

@RunWith(JUnit4.class)
public class WebTest {
    @Rule
    public final MockWebServer mockWebServer = new MockWebServer();
}

若不使用@Rule标记MockWebServer，则需在@Before与@After中分别调用其start()与shutdown()方法。

3.声明retrofit的service，此处分别测试MockWebServer的两种请求响应策略：队列与转发器

private interface Service {
        @FormUrlEncoded
        @POST("modify")
        Call modifyPerson(@Field("name") String name);

        @GET("person/{id}")
        Call fetchPersonById(@Path("id") int id);  
}

其中的实体类将在文末给出，实际开发中可使用真实地址，此处仅为假设。

4.实例化Service:

@Before
public void setup() {
    service = new Retrofit.Builder()
            .baseUrl(mockWebServer.url("/"))  //实际项目中可使用真实url
            .addConverterFactory(FastJsonConverterFactory.create())
            .build()
            .create(Service.class);
}

此处使用fastjson解析返回的json数据，其中若要使用FastJsonConverterFactory请添加如下依赖：
在根build.gradle中添加：

allprojects {
    repositories {
        maven { url "https://jitpack.io" }
    }
}

在module的build.gradle中添加：

dependencies {
    compile 'com.github.ZYRzyr:FastJsonConverter:v1.3-beta'
}

5.队列响应

调用MockWebServer的enqueue(MockResponse response)方法即可模拟一次请求响应：

@Test
public void testPOST() throws Exception {
    //模拟服务器的response
    mockWebServer.enqueue(new MockResponse().setBody("{\"name\": \"Tom\",\"age\": 100}"));

    Call call = service.modifyPerson("Tom");
    Person person = call.execute().body();

    assertNotNull(person);
    assertEquals("Tom", person.getName());
    assertEquals(100, person.getAge());
    assertEquals("POST", mockWebServer.takeRequest().getMethod());
}

6.转发器响应

需要手动编写Dispatcher并设置给MockWebServer:

@Test
public void testGET_WithParam() throws Exception {
    mockWebServer.setDispatcher(dispatcher);   //dispatcher见下文
    Call call = service.fetchPersonById(5);
    Person person = call.execute().body();

    assertNotNull(person);
    assertEquals("A", person.getName());
    assertEquals(11, person.getAge());
    assertEquals("GET", mockWebServer.takeRequest().getMethod());
}

dispatcher:

//dispatcher即为上文中的 mockWebServer.setDispatcher(dispatcher); 
private final Dispatcher dispatcher = new Dispatcher() {
    @Override
    public MockResponse dispatch(RecordedRequest request) throws InterruptedException {
        switch (request.getPath()) {
            case "/person/5":           //5即为GET请求fetchPersonById(@Path("id") int id)中的请求参数
                return new MockResponse().setResponseCode(200).setBody("{\"name\": \"A\",\"age\": 11}");
            default:
                return new MockResponse().setResponseCode(404);
        }
    }
};

上文中的实体类Person.java：

public class Person {
    private String name;
    private int age;

    public Person() {
    }

    public Person(String name, int age) {
        this.name = name;
        this.age = age;
    }
...省略getter、setter方法
}

最后

使用了MockWebServer进行API测试，直接省了很多编译、运行的时间，心情都要好了很多。若想了解更多的关于MockWebServer本身的东西，可以直接去它老巢查看。

原文作者/ZYRzyr
原文链接:http://www.jianshu.com/p/e906f7ee2a04

请进入这里获取授权：https://101709080007647.bqy.mobi