背景

客戶端開發(fā)過(guò)程中難免會(huì)遇到服務(wù)器接口尚未開發(fā)完成、服務(wù)器正在部署、測(cè)試服務(wù)器掛了等等情況導(dǎo)致接口無(wú)法訪問(wèn)，影響客戶端的調(diào)試。如果你們的APP的開發(fā)流程是某一個(gè)版本的客戶端和服務(wù)端同步開發(fā)的話，這種情況會(huì)更頻繁。這時(shí)候我們就需要一個(gè) Mock service 來(lái)為服務(wù)器接口請(qǐng)求做一個(gè)“假冒”的響應(yīng)了。

本文介紹我們項(xiàng)目基于 Retrofit 1.9.0 的一直簡(jiǎn)單的 Mock 實(shí)現(xiàn)。Retrofit 2.x 已經(jīng)出來(lái)很長(zhǎng)時(shí)間了，而且 2.x 有 內(nèi)建的 Mock 機(jī)制，所以對(duì)于 2.x，本文就沒有直接意義了。俺們?yōu)槭裁礇]有升級(jí) 2.x，因?yàn)檎邕x擇一個(gè)第三方庫(kù)是一個(gè)需要十分慎重的決定一樣，升級(jí)一個(gè)第三方庫(kù)也需要慎重，尤其是大版本升級(jí)。Retrofit 2.x 相對(duì)于1.x 有很大的變化，在俺們的項(xiàng)目目前用 1.9.0 沒有出過(guò)什么問(wèn)題的情況下，不想冒險(xiǎn)去升級(jí)2.x 。所以基于 1.9.0 實(shí)現(xiàn)了這很簡(jiǎn)單的 Mock，只在 Retrofit 1.9.0 測(cè)試過(guò)，但是相信 Retrofit 1.x 都能使用。

發(fā)現(xiàn)突破口

關(guān)于 Retrofit 的使用，前面的 這篇文章 已經(jīng)有介紹。
Retrofit 1.x 需要先 new RestAdapter.Builder()，并且需要調(diào)用這個(gè) Builder 實(shí)例的 setClient(final Client client) 方法來(lái)設(shè)置 Client （這里這個(gè) Client 的類型是 retrofit.client.Client）。一般來(lái)說(shuō)，也可以不調(diào)用 setClient()， RestAdapter 的 ensureSaneDefaults() 方法保證了有默認(rèn)值可以使用，具體可查看源碼。查看源碼可以發(fā)現(xiàn) retrofit.client.Client 的 Response execute(Request request) 方法就是執(zhí)行 Request 并得到 Response 的地方。那么我們就可以在這里入手做些文章。

實(shí)現(xiàn)

用裝飾者模式，實(shí)現(xiàn) Client 接口，把本來(lái)的 Client 包裝一下，來(lái)給 execute() 方法增加 mock 的職能。

class MyClient implements Client {

    private Client mClient;
    private MockServer mMockServer = null;

    /**
     * @param endPoint 服務(wù)器HOST
     * @param realClient 不用mock時(shí)，真正的client
     * @param interfaceClass 聲明API方法的interface
     */
    public MyClient(String endPoint, Client realClient, Class interfaceClass) {
        if (realClient == null) {
            throw new IllegalArgumentException("real client must not be null!");
        }

        this.mClient = realClient;
        if (Constants.MOCK_RESP_ENABLED) {
            this.mMockServer = new MockServer(endPoint, interfaceClass);
        }
    }

    @Override
    public Response execute(Request request) throws IOException {
        String url = request.getUrl();
        // 由于執(zhí)行到execute()方法時(shí)，如果是GET，request的url已經(jīng)帶了參數(shù)，
        // 所以我們需要處理url，取出一個(gè)API本身的path
        String path = null;
        try {
            int indexOfQuery = url.indexOf('?');
            if (indexOfQuery > 0) {
                path = url.substring(0, indexOfQuery);
            } else {
                path = url;
            }
        } catch (Exception ignored) {
        }

        Response mockResponse = null;
        // 配置一個(gè)是否啟用mock的開關(guān)，最好配置在build.gradle里，在上線前關(guān)閉
        if (Constants.MOCK_RESP_ENABLED) {
            // 根據(jù)path來(lái)區(qū)分是哪個(gè)API
            mockResponse = mMockServer.makeMockResponse(url, path);
        }

        // 如果這個(gè)API配置了mock，則使用mock，否則請(qǐng)求真實(shí)服務(wù)器接口
        if (mockResponse != null) {
            return mockResponse;
        } else {
            return mClient.execute(request);
        }
    }
}

接下來(lái)，MockServer 類的實(shí)現(xiàn)思路就很簡(jiǎn)單了， makeMockResponse() 方法針對(duì)不同的API（通過(guò) path 參數(shù)判斷）返回相應(yīng)的假數(shù)據(jù)即可。用一個(gè) HashMap<String, String> 來(lái)存儲(chǔ)path 對(duì)應(yīng) mock response 的鍵值對(duì)表，對(duì)相應(yīng)的API根據(jù)key查詢。

但是為了與 Retrofit 本身使用注解的風(fēng)格相統(tǒng)一，我們也可以使用注解來(lái)標(biāo)注一個(gè)接口方法的Mock。如：

interface MyApiService {

    // ...

    @MyMock(MockResponses.USER_INFO)
    @GET("/api/userInfo")
    void getUserInfo(Callback<String> cb);

    // ...
}

interface MockResponses {

    // ...
    
    String USER_INFO = "{\"status\":0,\"message\":\"\",\"data\":{\"nickname\":\"Donald Trump\",\"age\":70}}";
    
    // ...
}

自定義注解 MyMock ：

package me.tangni.xxx;

import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

/**
 * @author tangni
 */

@Documented
@Target(METHOD)
@Retention(RUNTIME)
public @interface MyMock {
    String value();
}

在 MockServer 中，構(gòu)造方法需要傳入聲明接口方法的 interface 的類型，本例中就是 MyApiService.class，然后通過(guò)反射，遍歷其中的所有聲明的方法，并取出每個(gè)方法的 @GET 或 @POST 注解 （暫時(shí)只處理這兩個(gè)）中的API的path，用作存儲(chǔ) Mock response 的 key。

public class MockServer {

    private HashMap<String, String> mockResps;

    public MockServer(String endPoint, Class interfaceClass) {
        if (Constants.MOCK_RESP_ENABLED) {
            mockResps = generateMockRespMap(endPoint, interfaceClass);
        }
    }

    /**
     *
     * @param reqUrl 請(qǐng)求的url
     * @param path 接口的path
     * @return 如果該接口指定了mock response，則返回mock response，否則返回null。
     */
    public Response makeMockResponse(String reqUrl, String path) {
        if (mockResps != null && mockResps.containsKey(path)) {
            String mockResp = mockResps.get(path);
            return generateMockResponse(reqUrl, mockResp, System.currentTimeMillis());
        } else {
            return null;
        }
    }

    private static HashMap<String, String> generateMockRespMap(String endPoint, Class interfaceClass) {
        HashMap<String, String> map = new HashMap<>();
        Method[] methods = interfaceClass.getDeclaredMethods();
        if (methods != null && methods.length > 0) {
            for (Method method : methods) {
                MyMock mockRespAnno = method.getAnnotation(MyMock.class);
                if (mockRespAnno != null) {
                    String path = null;
                    // TODO: 這里先只處理 GET 和 POST
                    Annotation methodAnno = method.getAnnotation(GET.class);
                    if (methodAnno == null) {
                        methodAnno = method.getAnnotation(POST.class);
                        if (methodAnno != null) {
                            path = ((POST)methodAnno).value();
                        }
                    } else {
                        path = ((GET)methodAnno).value();
                    }

                    if (!TextUtils.isEmpty(path)) {
                        String mockResp = mockRespAnno.value();
                        map.put(endPoint + path, mockResp);
                    }
                }
            }
        }
        return map;
    }

    private static Response generateMockResponse(String url, final String mockResp, long sentMillis) {
        final int contentLen = mockResp != null ? mockResp.length() : 0;

        List<Header> headers = new ArrayList<>();
        headers.add(new Header("Server", "MOCK-SERVER"));
        headers.add(new Header("Content-Type", "application/json;charset=UTF-8"));
        headers.add(new Header("OkHttp-Selected-Protocol", "http/1.1"));
        headers.add(new Header("OkHttp-Sent-Millis", String.valueOf(sentMillis)));
        headers.add(new Header("OkHttp-Received-Millis", String.valueOf(System.currentTimeMillis())));

        TypedInput body = new TypedInput() {
            @Override
            public String mimeType() {
                return "application/json;charset=UTF-8";
            }

            @Override
            public long length() {
                return contentLen;
            }

            @Override
            public InputStream in() throws IOException {
                String content = mockResp;
                if (content == null) {
                    content = "";
                }
                return new ByteArrayInputStream(content.getBytes("UTF-8"));
            }
        };

        return new Response(url, 200, "MOCK-OK", headers, body);
    }
}

最后，使用：

RestAdapter restAdapter = new RestAdapter.Builder()
        .setLogLevel(Constants.DEBUG ? RestAdapter.LogLevel.FULL : RestAdapter.LogLevel.NONE)
        .setRequestInterceptor(/*...*/)
        .setConverter(new MyCustomJsonConverter())
        .setClient(new MyClient(Constants.SERVER_HOST, new MyRealClient(), MyApiService.class))
        .setEndpoint(Constants.SERVER_HOST)
        .build();

mApiService = restAdapter.create(MyApiService.class);