Retrofit統一添加post請求的默認參數

前言

最近在學習使用Retrofit，並嘗試將之引入到現有的項目中來。你們都知道，在Http請求中咱們使用Content-Type來指定不一樣格式的請求信息：

APP_FORM_URLENCODED("application/x-www-form-urlencoded"),
    APP_JSON("application/json"),
    APP_OCTET_STREAM("application/octet-stream"),
    MULTIPART_FORM_DATA("multipart/form-data"),
    TEXT_HTML("text/html"),
    TEXT_PLAIN("text/plain"),
複製代碼

實際項目中一般最後的請求參數都包含默認的一些參數（Token，Api版本、App版本等）和普通的請求參數。網上有不少關於第一種Content-Type添加默認參數的方法（post-表單）。而在我現有項目上，除文件上傳外絕大多數請求都走了post-json的方式。這裏暫不討論二者的優缺點，而是談下Content-Type爲application/json時，如何去優雅地添加默認參數。

傳統方式：

咱們先來回憶下post-json的兩種方式

public interface Apis {
    
    @POST("user/login")
    Observable<Entity<User>> login(@Body RequestBody body);//構造一個RequestBody對象
    
    @POST("user/login")
    Observable<Entity<User>> login(@Body LoginInfo loginInfo);//構造一個實體對象
    
    }
    
複製代碼

第二種方法，你須要爲每個不一樣的請求的對象建立一個不一樣的Model，太麻煩了，這裏選擇第一種直接構造RequestBody對象：

Retrofit mRetrofit = new Retrofit.Builder()
                .baseUrl(HttpConfig.BASE_URL)
                .addConverterFactory(GsonConverterFactory.create())//添加gson轉換器
                .addCallAdapterFactory(RxJava2CallAdapterFactory.create())//添加rxjava轉換器
                .client(new OkHttpClient.Builder().build())
                .build();
Apis  mAPIFunction = mRetrofit.create(Apis.class);
Map<String, Object> params = new LinkedHashMap<>();
    params.put("name", "吳彥祖");
    params.put("request", "123456");
RequestBody requestBody = RequestBody.create(MediaType.parse("application/json; charset=utf-8"), JsonHelper.toJSONString(params));
mAPIFunction.login(RequestBody.create(requestBody))
複製代碼

執行後經過抓包查看，請求體以下：

而我但願的結果是這樣的：

固然咱們能夠每次構造 RequestBody,在傳入的參數中加入默認參數：

public static RequestBody getRequestBody(HashMap<String, Object> hashMap) {
        Map<String, Object> params = new LinkedHashMap<>();
        params.put("auth", getBaseParams());
        params.put("request", hashMap);
        return RequestBody.create(MediaType.parse("application/json; charset=utf-8"), JsonHelper.toJSONString(params));
    }
複製代碼

這樣徹底沒問題，但不夠優雅，因此接下來咱們來討論我所想到的一種方式

攔截器方式：

哈哈，相信熟悉OkHttp的同窗已經想到這種方式了，是的不少網上關於第一種Content-Type添加默認參數也是這麼作的(原文連接)：

@Override
    public Response intercept(Chain chain) throws IOException {
        Request request = chain.request();
        if (request.method().equals("POST")) {
       if (request.body() instanceof FormBody) {
            FormBody.Builder bodyBuilder = new FormBody.Builder();
            FormBody formBody = (FormBody) request.body();
            //把原來的參數添加到新的構造器，（由於沒找到直接添加，因此就new新的）
            for (int i = 0; i < formBody.size(); i++) {
                bodyBuilder.addEncoded(formBody.encodedName(i), formBody.encodedValue(i));
            }
            formBody = bodyBuilder
                    .addEncoded("clienttype", "1")
                    .addEncoded("imei", "imei")
                    .addEncoded("version", "VersionName")
                    .addEncoded("timestamp", String.valueOf(System.currentTimeMillis()))
                    .build();

            request = request.newBuilder().post(formBody).build();
        }
         return chain.proceed(request);
       }
複製代碼

在上面，咱們拿到了request對象，而後拿到了requestBody對象，而後 判斷是否是FormBody類型，若是是的話，將裏面的鍵值對取出，並添加默認參數的鍵值對並構造出一個新的formBody對象，最後將原來用request對象構造出新的一個request對象，將新的formBody對象穿進去，攔截器返回。formBody對象是Content-Type爲application/x-www-form-urlencoded時,Retrofit爲咱們生成的對象,它是RequestBody的子類；而Content-Type爲application/json時，生成的就是RequestBody(準確的說是匿名子類)。因此咱們只要繼承重寫RequestBody，記錄請求內容，再將它在攔截器裏取出加入並處理就好了。

public class PostJsonBody extends RequestBody {

    private static final MediaType JSON = MediaType.parse("application/json; charset=utf-8");
    private static final Charset charset = Util.UTF_8;

    private String content;

    public PostJsonBody(@NonNull String content) {
        this.content = content;
    }

    public String getContent() {
        return content;
    }

    @Nullable
    @Override
    public MediaType contentType() {
        return JSON;
    }

    @Override
    public void writeTo(@NonNull BufferedSink sink) throws IOException {
        byte[] bytes = content.getBytes(charset);
        if (bytes == null) throw new NullPointerException("content == null");
        Util.checkOffsetAndCount(bytes.length, 0, bytes.length);
        sink.write(bytes, 0, bytes.length);
    }

    public static RequestBody create(@NonNull String content) {
        return new PostJsonBody(content);
    }
}
複製代碼

攔截器裏面取出原始json數據，並添加新的默認參數：

@Override
    public Response intercept(@NonNull Chain chain) throws IOException {
        Request originalRequest = chain.request();
        Request.Builder builder = originalRequest.newBuilder();
        if (originalRequest.method().equals("POST")) {
            RequestBody requestBody = originalRequest.body();
            if (requestBody instanceof PostJsonBody) {
                String content = ((PostJsonBody) requestBody).getContent();
                HashMap<String, Object> hashMap = JsonHelper.fromJson(content, HashMap.class);
                builder.post(RequestBodyFactory.getRequestBody(hashMap));
            }
        }
        return chain.proceed(builder.build());
    }
複製代碼

這樣在外面咱們只要改動一行代碼就能夠實現全局添加默認參數：

RequestBody requestBody =
 RequestBody.create(MediaType.parse("application/json;charset=utf-8"),JsonHelper.toJSONString(params));
複製代碼

替換爲：

RequestBody requestBody = PostJsonBody.create( JsonHelper.toJSONString(params));
複製代碼

不成熟的想法：

先來回顧下post-表單的用法，咱們將前面的登錄改用post-表單定義以下：

@FormUrlEncoded      //@FormUrlEncoded將會自動將請求參數的`content
    @POST("user/login")
    Observable<Entity<User>> login(@Field("account") String name, @Field("password") String password);
複製代碼

相比post-json的api定義是否是一目瞭然多了?並且不須要在調用接口的時候本身構造HashMap和requestBody,請求方法裏面定義的參數和咱們從輸入框中拿到的原始數據已經一一對應，直接調用就行了：

mAPIFunction.login("吳彥祖","123456");
複製代碼

但缺點上面也說了，post-表單的請求體裏面只能有鍵值對參數，不能描述更復雜的對象，若是統一在攔截器裏面加入了默認參數也只能和普通參數混在一塊兒：

因此能不能結合二者優勢呢？若是普通請求參數是鍵值對參數的話，這是能夠的，原理就是在Api接口定義的時候定義爲post-表單，而後在OkHttp攔截器裏面加入默認參數，並將post-表單請求改成post-json請求（get請求也是一樣的方法）：

public class AddQueryParameterInterceptor implements Interceptor {

    @Override
    public Response intercept(@NonNull Chain chain) throws IOException {
        Request originalRequest = chain.request();
        Request.Builder builder = originalRequest.newBuilder();
        if (originalRequest.method().equals("POST")) {
            RequestBody requestBody = originalRequest.body();
            if (requestBody instanceof PostJsonBody) {
                String content = ((PostJsonBody) requestBody).getContent();
                HashMap<String, Object> hashMap = JsonHelper.fromJson(content, HashMap.class);
                builder.post(RequestBodyFactory.getRequestBody(hashMap));
            } else if (requestBody instanceof FormBody) {
                FormBody formBody = (FormBody) requestBody;
                LinkedHashMap<String, Object> hashMap = new LinkedHashMap<>();
                for (int i = 0; i < formBody.size(); i++) {
                    hashMap.put(formBody.encodedName(i), formBody.encodedValue(i));
                }
                builder.post(RequestBodyFactory.getRequestBody(hashMap));
            }
        }
        return chain.proceed(builder.build());
    }

}
複製代碼

若是你原有項目裏面有不少get請求或者post-表單請求的接口，想把他們統一改爲post-json方式的話，這是一種不用動上層的簡單方法。