Volley的二次封装以及返回泛型的处理

相信大家在平时的开发中都或多或少的引用一些优秀的开源框架来提高项目的开发速度,那么在使用时,有没有想过对这些框架进行二次封装呢,假如你今天使用的是volley,明天项目要求使用retrofit或者asynchttp等其他网络框架,那么如果你没进行二次封装,那么改起来将会是很痛苦的一件事,每一个调用网络请求的地方你都需要去修改。

本文将对volley进行二次封装,如果不知道volley为何物或者如何使用的,可以先看郭霖大神博客Android Volley完全解析(一),初识Volley的基本用法再来看本文。

Ok,Let's go!

假设我们和服务端约定的返回数据格式(这个根据自身需求定制)为

{"code":"200","msg":"成功","data":{}}

如果我们每次请求都进行解析,那么会出现非常多重复的代码,而我们一般都是只关心data中的数据,那么我们的目的就是直接通过回调获得data中的数据,至于code的判断,交给二次封装中的代码。

根据上面的json格式,我们创建对应的实体类

public class HttpResult {

    private Object data;
    private int code;
    private String msg;

    public Object getData() {
        return data;
    }

    public void setData(Object data) {
        this.data = data;
    }

    public int getCode() {
        return code;
    }

    public void setCode(int code) {
        this.code = code;
    }

    public String getMsg() {
        return msg;
    }

    public void setMsg(String msg) {
        this.msg = msg;
    }
}

我们还需要一个泛型回调类用于回调结果,其中onSuccess是成功回调,onFail是失败回调。

public abstract class HttpCallBack<T> {

    public abstract void onSuccess(T data);

    public abstract void onFail(String msg);
}

其中泛型T就是json中data对应的数据,如果data中是一个User实体,那么我们回调直接写成HttpCallBack<User>,如果data中是一个User数组,那么我们回调直接写成HttpCallBack<List<User>>,再如果我们只想获得data中的json字符串,那么就是HttpCallBack<String>。是不是想想都觉得很爽,使用时自己不需要任何的解析。当然,现在只是预想,这些返回都需要我们在封装中进行判断处理。

这里我们使用Gson进行json的解析,使用Gson解析json很简单,只需要使用public <T> T fromJson(String json, Type typeOfT),其中json参数无需多说,是json字符串,typeOfT是泛型T的类型,方法返回的是泛型T,这时,我们只需要传入正确的Type,就可得到我们需要的数据然后通过回调传出去。

那么问题来了,Type如果获取呢?在我们的封装中,我们只需要获取HttpCallBack<T>中T的类型,怎么获取呢?答案是ParameterizedType,ParameterizedType 就是形如“ 类型<> ”的类型,如HttpCallBack<T>、List<T>、Map<String,User>。比如Map<String,User>,我们通过getActualTypeArguments()方法可以获得Type[],里面的内容是[String.class,User.class],数组的长度由< >中的个数决定。具体代码如下:

public static Type getTType(Class<?> clazz) {
    Type mySuperClassType = clazz.getGenericSuperclass();
    Type[] types = ((ParameterizedType) mySuperClassType).getActualTypeArguments();
    if (types != null && types.length > 0) {
        //T
        return types[0];
    }
    return null;
}

其中class参数是HttpCallBack<T>的引用,返回值就是HttpCallBack<T>中T的type。假设我们的回调是HttpCallBack<User>,那么返回的Type就是User.class;假设我们的回调是HttpCallBack<List<User>>,那么返回的Type就是List<User>,此时再使用上面提到的Gson进行解析,就很轻松了。

接下来就是二次封装的主要代码

public class HttpUtil {

    private static HttpUtil mHttpUtil;
    private Gson mGson;

    //请求连接的前缀
    private static final String BASE_URL = "";

    //连接超时时间
    private static final int REQUEST_TIMEOUT_TIME = 60 * 1000;

    //volley请求队列
    public static RequestQueue mRequestQueue;

    private HttpUtil() {
        mGson = new Gson();
        //这里使用Application创建全局的请求队列
        mRequestQueue = Volley.newRequestQueue(MyApplication.myApplication);
    }

    public static HttpUtil getInstance() {
        if (mHttpUtil == null) {
            synchronized (HttpUtil.class) {
                if (mHttpUtil == null) {
                    mHttpUtil = new HttpUtil();
                }
            }
        }
        return mHttpUtil;
    }

    /**
     * http请求
     *
     * @param url          http地址(后缀)
     * @param param        参数
     * @param httpCallBack 回调
     */
    public <T> void request(String url, final Map<String, String> param, final HttpCallBack<T> httpCallBack) {
        StringRequest stringRequest = new StringRequest(Request.Method.POST, BASE_URL + url,
                new Response.Listener<String>() {
                    @Override
                    public void onResponse(String response) {
                        if (httpCallBack == null) {
                            return;
                        }
                        
                        Type type = getTType(httpCallBack.getClass());

                        HttpResult httpResult = mGson.fromJson(response, HttpResult.class);
                        if (httpResult != null) {
                            if (httpResult.getCode() != 200) {//失败
                                httpCallBack.onFail(httpResult.getMsg());
                            } else {//成功
                                //获取data对应的json字符串
                                String json = mGson.toJson(httpResult.getData());
                                if (type == String.class) {//泛型是String,返回结果json字符串
                                    httpCallBack.onSuccess((T) json);
                                } else {//泛型是实体或者List<>
                                    T t = mGson.fromJson(json, type);
                                    httpCallBack.onSuccess(t);
                                }
                            }
                        }
                    }
                }, new Response.ErrorListener() {
            @Override
            public void onErrorResponse(VolleyError error) {
                if (httpCallBack == null) {
                    return;
                }
                String msg = error.getMessage();
                httpCallBack.onFail(msg);
            }
        }) {
            @Override
            protected Map<String, String> getParams() throws AuthFailureError {
                //请求参数
                return param;
            }

        };
        //设置请求超时和重试
        stringRequest.setRetryPolicy(new DefaultRetryPolicy(REQUEST_TIMEOUT_TIME, 1, 1.0f));
        //加入到请求队列
        if (mRequestQueue != null)
            mRequestQueue.add(stringRequest.setTag(url));
    }

    private Type getTType(Class<?> clazz) {
        Type mySuperClassType = clazz.getGenericSuperclass();
        Type[] types = ((ParameterizedType) mySuperClassType).getActualTypeArguments();
        if (types != null && types.length > 0) {
            //T
            return types[0];
        }
        return null;
        }
}

其中,我们规定了请求全部为post,如果项目中既有post又有get,那么可以通过传参的方式进行设置。

接下来是如何调用:

类型一:User

    Map<String, String> param = new HashMap<>();
    param.put("account", "zhijieeeeee");
    param.put("password", "123456");
    HttpUtil.getInstance().request("UserController/login", param, new HttpCallBack<User>() {
        @Override
        public void onSuccess(User user) {
        }

        @Override
        public void onFail(String msg) {
        }
    });

类型二:List<User>

    Map<String, String> param = new HashMap<>();
    param.put("currentPage", "1");
    HttpUtil.getInstance().request("InputController/getUserList", param, new HttpCallBack<List<User>>() {
        @Override
        public void onSuccess(List<User> list) {
        }

        @Override
        public void onFail(String msg) {
        }
    });

类型三:String

    Map<String, String> param = new HashMap<>();
    param.put("currentPage", "1");
    HttpUtil.getInstance().request("CropController/getCropList", param, new HttpCallBack<String>() {
        @Override
        public void onSuccess(String data) {
        }

        @Override
        public void onFail(String msg) {
        }
    });

现在,我们二次封装全部完成了,假如明天你需要换网络请求框架,那么只需要修改HttpUtil中request方法的实现代码就行,其他调用HttpUtil.getInstance().request()的地方全部不用修改,很轻松完成了框架的切换。

这里给出依赖的库

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

推荐阅读更多精彩内容