Retrofit + OkHttp 网络请求公共参数的封装


在实际项目中,网络接口可能需要添加多个公共的参数,如果每次请求都手动添加这些参数,简直可怕!

接下来我们就对OkHttp的公共请求参数进行封装


Retrofit
简单的Retrofit 的Get请求如下:

@GET("group")
Call<List<User>> groupList(@Query("sort") String sort);

Post请求:

@FormUrlEncoded
@POST("user/edit")
Call<User> updateUser(@Field("first_name") String first, @Field("last_name") String last);

这里每个公司的接口设计不同,公共参数的规则不同,这里只是给出一个例子,具体的逻辑还是需要根据接口设计规则来

例如下面的规则:
客户端上传的参数格式为 json 形式
{
“publicParams”:{...},
“key1”:value,
“key2”:value
}
说明:

Get请求 使用公共的Q uery值为:p

Form 表单格式

publicParams {...}
key1 value1
... ...

封装的类的代码如下:

public class HttpParamInterceptor implements Interceptor {

  

    public HttpParamInterceptor() {
    }

    @Override
    public Response intercept(Chain chain) throws IOException {
        //公共参数
        HashMap<String, Object> commonMap = new HashMap<>();
      
        commonMap.put("paramName", "paramValue");
       
        //获取 缓存的 token
        String token = ACache.get(mContext).getAsString("token");
      //将token传入公共参数
        if (!TextUtils.isEmpty(token)) {
            Log.e("TAG", "token:"+token);
            commonMap.put("token", token);
        }
        //请求对象
        Request request = chain.request();
        String method = request.method();
        if ("GET".equals(method)) {  //GET请求
          
           //获取请求的Url
            HttpUrl url = request.url();
          //请求参数集合
            Set<String> paramNames = url.queryParameterNames();

            //最终的结果为 "p":"{“publicParams”:{...},“key1”:value,“key2”:value}"}
            HashMap<String, Object> rootMap = new HashMap<>();
            for (String paramName : paramNames) {
                if ("p".equals(paramName)) {
                    String oldParams = url.queryParameter(Constant.API_PARAM);
                    if (!TextUtils.isEmpty(oldParams)) {
                      
                        HashMap<String, Object> hashMap = new Gson().fromJson(oldParams, HashMap.class);
                      //获取传入的参数,并整合到 最终 map 中
                        if (hashMap != null) {
                            Set<Map.Entry<String, Object>> entries = hashMap.entrySet();
                            for (Map.Entry<String, Object> entry : entries) {
                                rootMap.put(entry.getKey(), entry.getValue());
                            }
                        }
                    }
                } else {
                  //对于多页请求  如果 直接传入 page 参数,没有 @Query 参数 这里会将参数整合
                    rootMap.put(paramName, url.queryParameter(paramName));
                }
            }
            rootMap.put("publicParams", commonMap); //重新组装的参数

            String newParams = new Gson().toJson(rootMap);

            String newUrl = url.toString();
            //由于是get 请求 直接对url 的拼接操作
            int index = newUrl.indexOf("?");
            if (index > 0) {
                newUrl = newUrl.substring(0, index);
            }
          //重新整合 params
            newUrl = newUrl + "?" + Constant.API_PARAM + "=" + newParams;
            request = request.newBuilder().url(newUrl).build();
          
        } else if ("POST".equals(method)) {  //POST 请求
            RequestBody body = request.body();
            HashMap<String, Object> rootMap = new HashMap<>();
         
            if (body instanceof FormBody) {//表单数据
              
                FormBody formBody = (FormBody) body;
                FormBody.Builder builder = new FormBody.Builder();
                int size = formBody.size();
              //  传入的FormBody 内容
                for (int i = 0; i < size; i++) {
                    builder.add(formBody.name(i), formBody.value(i));
                }
              //拼接common参数
                String commonParam = new Gson().toJson(commonMap);
                builder.add(Constant.PUBLICPARAMS, commonParam);

                formBody = builder.build();

                request = request.newBuilder()
                        .post(formBody)
                        .build();

            } else {   // post 的Json 数据
              
                Buffer buffer = new Buffer();
                body.writeTo(buffer);
                String oldParams = buffer.readUtf8(); //读取 传入的 json 字符串
                if (oldParams != null) {
                  //拼接参数
                    rootMap = new Gson().fromJson(oldParams, HashMap.class);
                    rootMap.put(Constant.PUBLICPARAMS, commonMap);
                    String newJsonParams = new Gson().toJson(rootMap);
                    
                  //request 的重新构建
                    MediaType JSON
                            = MediaType.parse("application/json; charset=utf-8");
                    request = request.newBuilder()
                            .post(RequestBody.create(JSON, newJsonParams))
                            .build();
                }

            }


        }

        return chain.proceed(request);
    }

}
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,189评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,577评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,857评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,703评论 1 276
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,705评论 5 366
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,620评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,995评论 3 396
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,656评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,898评论 1 298
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,639评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,720评论 1 330
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,395评论 4 319
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,982评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,953评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,195评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 44,907评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,472评论 2 342

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,421评论 25 707
  • 国家电网公司企业标准(Q/GDW)- 面向对象的用电信息数据交换协议 - 报批稿:20170802 前言: 排版 ...
    庭说阅读 10,858评论 6 13
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,594评论 18 139
  • 第三章 秦汉魏晋南北朝时期 在上一节中,讲述了乐府机构,鼓吹乐和相和歌这三个比较重要的内容。在中国古代音乐史的...
    韫左寻阅读 1,120评论 0 4
  • 阳光正好,午时三刻。 海珍在喂鸭子,嘎嘎叫的草鸭团团围着她,一点儿也不怕生。 因为这是她养大的鸭子,从黄绒绒的小可...
    双子与蛇阅读 223评论 0 0