利用Volley框架的可扩展性自定义HttpRequest
上一篇博客中介绍了一下volley框架的原理与源码解析,事实上在实际开发过程中,volley框架的自带的JsonObjectRequest、JsonArrayRequest、ImageRequest已经可以应对大部分的场景,即使对于一些特殊的情况,如非json格式的POST请求、需要http基本验证的请求等,也可以通过重写Request<>抽象类,自定义需要的请求与回调操作,从而简化开发过程中一些不必要的繁琐操作。
以最近的课程作业Tss客户端为例,服务器端提供了restful接口供客户端调用并获得数据,但所有接口都需要通过http基本验证。浏览器自带保存base64验证序列的功能,但在android客户端中为了避免每次请求都加上一次验证信息,因此我选择通过重写volley框架中的Request<>自动为已登陆的用户添加验证信息,相关代码如下:
public class HttpBasicJsonObjectRequest extends Request {
private Listener listener;
private SharedPreferences sp;
public HttpBasicJsonObjectRequest(String url, SharedPreferences sp, Listener listener, ErrorListener errorListener) {
super(Method.GET, url, errorListener);
this.listener = listener;
this.sp = sp;
}
@Override
public Map getHeaders() throws AuthFailureError {
String base64 = sp.getString("auth", null);
Map header = new HashMap<>();
header.put("Authorization", base64);
return header;
}
/*
@Override
protected Map getParams() {
//some code
}
*/
@Override
protected Response parseNetworkResponse(NetworkResponse response) {
try {
String jsonString = new String(response.data, HttpHeaderParser.parseCharset(response.headers));
return Response.success(new JSONObject(jsonString),HttpHeaderParser.parseCacheHeaders(response));
} catch (UnsupportedEncodingException e) {
return Response.error(new ParseError(e));
} catch (JSONException je) {
return Response.error(new ParseError(je));
}
}
@Override
protected void deliverResponse(JSONObject response) {
listener.onResponse(response);
}
}
以上代码的重写内容包括:
构造函数中额外传入了来自Android Context的SharedPreferences,这是经常被用于在多个Activity间传递共享数据的类,我在这里也用它保存登陆成功后的base64验证数据:
SharedPreferences sp = getSharedPreferences("auth", MODE_PRIVATE);
SharedPreferences.Editor editor = sp.edit();
editor.clear();
editor.putString("auth", "Basic "+Base64.encodeToString((email+":"+password).getBytes(), Base64.DEFAULT));
重写getHeaders()方法,返回体为一个易于操作的Map,所以实现自动Http验证的操作很简单,即在一个HashMap中添加一个键为"Authorization",值为base64验证码的键值对并返回即可,而base64验证码通过SharedPreference传递也是非常方便的。
对getParams()方法的重写主要用于实现一些Map<>数据格式的POST参数,volley自带的三种Request只支持JsonObject格式的参数,所以若需要传入Map格式的参数时,除了提前把Map转换为JsonObject,这种方式显然更加直观与简洁。
deliverResponse (JSONObject response)方法与parseNetworkResponse (NetworkResponse response)方法的重写则是处理返回的Response的操作,因为volley自带的JSONObject类有非常优秀的直接把字符串转换为json格式的对象的功能,因此这里的代码非常简单,如上所示的写法基本可以满足我们的需求。
下面是一个实际使用这个自定义Request的例子:
HttpBasicJsonObjectRequest request = new HttpBasicJsonObjectRequest(url, getSharedPreferences("auth", MODE_PRIVATE),
new Response.Listener() {
@Override
public void onResponse(JSONObject response) {
handleResponse(response);
}
}, new Response.ErrorListener() {
@Override
public void onErrorResponse(VolleyError error) {
Toast.makeText(getApplicationContext(), "HTTP验证失败 请重新登陆", Toast.LENGTH_LONG).show();
startActivity(new Intent(QuestionAnalysisActivity.this, LoginActivity.class));
finish();
}
});
在因为一些特殊原因导致之前存储的http基本验证码失效时,便可以通过volley框架中的ErrorListener回调,跳转回登录页面,并清空之前的SharedPreference中存储的内容。
图片URL请求与Bitmap操作
通过URL获得图片的操作可以通过volley自带的ImageRequest实现,这种特殊的请求类的返回(回调参数)为Bitmap,因此我们可以方便地使用ImageView的setImageBitmap方法显示获得的图片资源。一般来说图片的数据传输量远大于普通的rest请求,相对来说比较耗时,但volley框架自带一个性能相当优秀的缓存机制,所以,虽然volley并不建议使用其进行大数据量的网络操作,但通过该缓存机制在实际应用中可以避免很多重复的低速请求,一个简单的例子如下:
ImageRequest imageRequest = new ImageRequest(avatarUrl, new Response.Listener() {
@Override
public void onResponse(Bitmap response) {
avatar.setImageBitmap(response);
}
}, 400, 400, Bitmap.Config.ALPHA_8, new Response.ErrorListener() {
@Override
public void onErrorResponse(VolleyError error) {
Toast.makeText(getApplicationContext(), "图片加载失败", Toast.LENGTH_SHORT).show();
}
});
传参中可以自由地控制图片的最大长宽与颜色模式。
有一个很有意思的需求是,希望加载出的图片以圆形边框呈现。事实上这种需求有相当多的实现方法,例如利用Bitmap的与或操作,将原图与一个圆形图片相叠,非圆的地方会不再显示。或者继承ImageView,重写invalidate()、onDraw()等方法实现特殊的ImageView。
不过我们没有必要重复造轮子,如来自https://github.com/hdodenhof/CircleImageView 的CircleImageView便是一个优秀的自定义ImageView实现,它内部通过对Paint、Canvas、BitmapShader、Matrix、RectF类的操作实现一些必要的圆形化、加边框等功能,可以通过在gradle中直接引入
dependencies {
compile 'de.hdodenhof:circleimageview:2.1.0'
}
添加对其的依赖。在布局xml文件中直接将ImageView标签替换为CircleImageView标签便可直接操作一些可用的属性,如以下圆形化+边框的xml代码:
DownloadManager API介绍
当需要进行一些数据量较大的下载操作时,之前涉及的一些网络接口操作便不再适用。而Android API9之后自带的DownloadManager组件便是用于处理这种场景。相对来说功能比较全面,使用也非常简洁,所以下面介绍一下DownloadManager的API与其功能。
DownloadManager对象获得方式为调用Context的getSystemService (Context.DOWNLOAD_SERVICE)。
addCompeletedDownload
long addCompletedDownload (String title, String description, boolean isMediaScannerScannable, String mimeType, String path, long length, boolean showNotification)
long addCompletedDownload (String title, String description, boolean isMediaScannerScannable, String mimeType, String path, long length, boolean showNotification, Uri uri, Uri referer)
该接口为API 24新增的接口,作用为将一个下载完成的文件加入Downloads App。参数分别为:
title 显示在Downloads App中的标题
description 显示在Downloads App中的简介
isMediaScannerScannable 是否可以被MediaScanner检测到
mimeType 文件类型
path 文件真实路径
length 文件大小
showNotification 是否显示通知
uri 下载的原始Http Uri
referer 下载来源Http referer部分
返回一个长整型数据,作为该文件的ID,方便其他地方获得它
enqueue
long enqueue (DownloadManager.Request request)
DownloadManager.Request为DownloadManager的一个内部类,含义为下载请求的Request对象,构造一个request实例需要传入下载链接Uri。
调用该方法即为将该链接加入下载队列,返回下载文件的一个长整型ID。
getMaxBytesOverMobile
Long getMaxBytesOverMobile (Context context)
获得Mobile Connection所支持的最大下载文件字节数,若返回为Null则意为不做限制,可以通过该方法判断是否令要下载的文件仅在WIFI下可下载。
getRecommendedMaxBytesOverMobile
Long getRecommendedMaxBytesOverMobile (Context context)
同上,返回推荐字节大小
getMimeTypeForDownloadedFile
String getMimeTypeForDownloadedFile (long id)
获得下载文件的文件格式,传入下载文件的id,即为之前的某几个方法的返回值,返回字符串表示的文件格式。
getUriForDownloadedFile
Uri getUriForDownloadedFile (long id)
传入下载文件的id,获得源下载链接的Uri。
openDownloadedFile
ParcelFileDescriptor openDownloadedFile (long id)
传入下载文件的id,获得一个只读的文件描述符,利用ParcelFileDescriptor可进行相应的文件操作。
query
Cursor query (DownloadManager.Query query)
Query对象通过setsetFilterById(long reference)方法与某个下载任务绑定,通过传入该对象可以返回一个Cursor类型的对象,而Cursor是一个关于该下载的结果集。可以通过该方法来查询某个下载的状态。
remove
int remove (long... ids)
通过传入一系列下载任务的ID来取消它们的下载操作,返回值为一个int,代表被实际取消的下载数。
总之DownloadManager通过一些简洁的接口,封装了繁琐的网络连接操作,帮助开发者实现一些复杂的下载过程,具体案例相对比较丰富,因此不在此给出实践代码。
http://blog.csdn.net/lingjianglin/article/details/51658315 便为一个利用DownloadManager实现软件自动更新的实例代码。
谢谢阅读。