一種基于Retrofit 1.x的簡單Mock機制

背景

客戶端開發過程中難免會遇到服務器接口尚未開發完成、服務器正在部署、測試服務器掛了等等情況導致接口無法訪問，影響客戶端的調試。如果你們的APP的開發流程是某一個版本的客戶端和服務端同步開發的話，這種情況會更頻繁。這時候我們就需要一個 Mock service 來為服務器接口請求做一個“假冒”的響應了。

本文介紹我們項目基于 Retrofit 1.9.0 的一直簡單的 Mock 實現。Retrofit 2.x 已經出來很長時間了，而且 2.x 有 內建的 Mock 機制，所以對于 2.x，本文就沒有直接意義了。俺們為什么沒有升級 2.x，因為正如選擇一個第三方庫是一個需要十分慎重的決定一樣，升級一個第三方庫也需要慎重，尤其是大版本升級。Retrofit 2.x 相對于1.x 有很大的變化，在俺們的項目目前用 1.9.0 沒有出過什么問題的情況下，不想冒險去升級2.x 。所以基于 1.9.0 實現了這很簡單的 Mock，只在 Retrofit 1.9.0 測試過，但是相信 Retrofit 1.x 都能使用。

發現突破口

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

實現

用裝飾者模式，實現 Client 接口，把本來的 Client 包裝一下，來給 execute() 方法增加 mock 的職能。

class MyClient implements Client {

    private Client mClient;
    private MockServer mMockServer = null;

    /**
     * @param endPoint 服務器HOST
     * @param realClient 不用mock時，真正的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();
        // 由于執行到execute()方法時，如果是GET，request的url已經帶了參數，
        // 所以我們需要處理url，取出一個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;
        // 配置一個是否啟用mock的開關，最好配置在build.gradle里，在上線前關閉
        if (Constants.MOCK_RESP_ENABLED) {
            // 根據path來區分是哪個API
            mockResponse = mMockServer.makeMockResponse(url, path);
        }

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

接下來，MockServer 類的實現思路就很簡單了， makeMockResponse() 方法針對不同的API（通過 path 參數判斷）返回相應的假數據即可。用一個 HashMap<String, String> 來存儲path 對應 mock response 的鍵值對表，對相應的API根據key查詢。

但是為了與 Retrofit 本身使用注解的風格相統一，我們也可以使用注解來標注一個接口方法的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 中，構造方法需要傳入聲明接口方法的 interface 的類型，本例中就是 MyApiService.class，然后通過反射，遍歷其中的所有聲明的方法，并取出每個方法的 @GET 或 @POST 注解 （暫時只處理這兩個）中的API的path，用作存儲 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 請求的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);
最后編輯于 ：
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明：文章內容（如有圖片或視頻亦包括在內）由作者上傳并發布，文章內容僅代表作者本人觀點，簡書系信息發布平臺，僅提供信息存儲服務。

推薦閱讀更多精彩內容

  • Android 自定義View的各種姿勢1 Activity的顯示之ViewRootImpl詳解 Activity...
    passiontim閱讀 173,466評論 25贊 708
  • Spring Cloud為開發人員提供了快速構建分布式系統中一些常見模式的工具（例如配置管理，服務發現，斷路器，智...
    卡卡羅2017閱讀 134,981評論 19贊 139
  • 國家電網公司企業標準（Q/GDW）- 面向對象的用電信息數據交換協議 - 報批稿：20170802 前言： 排版 ...
    庭說閱讀 11,178評論 6贊 13
  • —1— 小時候性格咋咋呼呼 在班里有一種“我就是老大”的感覺 朋友挺多 但無法交心 有一段時間我和燕子、曼曼關系很...
    一號公路上閱讀 284評論 0贊 0
  • 很多時候我們都拼命的想要別人別的更好，想要給他更好，卻忘記了本質這種東西。本質使然，豈是你我之力可以扭轉的
    Qiao雪蓮閱讀 164評論 0贊 0