描述:一个基于回调的安卓Http客户端库for Android
1.概要
建立在Apache HttpClient之上的一个异步的基于回调的安卓Http客户端库。所有的请求都在app主线程之外得到处理,但是任何的回调逻辑模块都会在相同的线程上执行,回调使用安卓的处理程序创建消息传递。你也可以在服务端或者后台线程使用这个库,这个库将自动识别上下文在哪里运行。
2.特点
(1)使用最新的 4.3.6的HttpClient 版本而不是安卓自带的默认的版本。
(2)兼容安卓API23以上版本
(3)异步Http请求,以匿名回调的方式处理响应。
(4)UI主线程之外处理HTTP请求
(5)包含GET/POST参数构建方法(请求参数)
(6)大部分的文件上传不需要额外的第三方库
(7)数据通过json格式上传不需要其他的库
(8)处理循环和相关的重传
(9)在你的应用程序中占用极小的内存空间,只有90KB
(10)移动连接质量差的情况下自动的智能优化的请求重试
(11)支持超快请求的自动压缩程序的接收解码
(12)用BinaryHttpResponseHandler进行二进制协议交互
(13)用JsonHttpResponseHandler内置打包成Json
(14)用 FileAsyncHttpResponseHandler将回应直接保存为文件
(15)持续的cookie保存,将cookie存入你的应用的SharedPreferences
(16)用BaseJsonHttpResponseHandler整合Jackson JSON, Gson或者其他JSON (de)一连串的字典
(17)以SaxAsyncHttpResponseHandler支持SAX语法分析
(18)支持语句解码和内容解码,而不仅仅是UTF-8
3.被顶尖应用和开发者在产品中应用的例子
Instagram、Pinterest、Frontline Commando (Glu Games)、Heyzap、Pose等(都是国外知名安卓APP软件)
4.安装和基本用法
(1)到官网http://loopj.com/android-async-http/下载最新的android-async-http-1.4.4.jar,然后将此jar包添加进Android应用程序 libs文件夹
(2)通过import com.loopj.android.http.*;引入相关类
(3)创建异步请求
AsyncHttpClient client = new AsyncHttpClient();
client.get("https://www.google.com", new AsyncHttpResponseHandler() {
@Override
public void onStart() {
// called before request is started
}
@Override
public void onSuccess(int statusCode, Header[] headers, byte[] response) {
// called when response HTTP status is "200 OK"
}
@Override
public void onFailure(int statusCode, Header[] headers, byte[] errorResponse, Throwable e) {
// called when response HTTP status is "4XX" (eg. 401, 403, 404)
}
@Override
public void onRetry(int retryNo) {
// called when request is retried
}
});
5.推荐用法:使用静态HTTP客户端
在下面这个例子,我们创建了静态的http client对象,使其很容易连接到Twitter的API
import com.loopj.android.http.*;
public class TwitterRestClient {
private static final String BASE_URL = "https://api.twitter.com/1/";
private static AsyncHttpClient client = new AsyncHttpClient();
public static void get(String url, RequestParams params, AsyncHttpResponseHandler responseHandler) {
client.get(getAbsoluteUrl(url), params, responseHandler);
}
public static void post(String url, RequestParams params, AsyncHttpResponseHandler responseHandler) {
client.post(getAbsoluteUrl(url), params, responseHandler);
}
private static String getAbsoluteUrl(String relativeUrl) {
return BASE_URL + relativeUrl;
}
}
然后我们可以很容易的在代码中操作Twitter的API
import org.json.*;
import com.loopj.android.http.*;
class TwitterRestClientUsage {
public void getPublicTimeline() throws JSONException {
TwitterRestClient.get("statuses/public_timeline.json", null, new JsonHttpResponseHandler() {
@Override
public void onSuccess(int statusCode, Header[] headers, JSONObject response) {
// If the response is JSONObject instead of expected JSONArray
}
@Override
public void onSuccess(int statusCode, Header[] headers, JSONArray timeline) {
// Pull out the first event on the public timeline
JSONObject firstEvent = timeline.get(0);
String tweetText = firstEvent.getString("text");
// Do something with the response
System.out.println(tweetText);
}
});
}
}
查阅AsyncHttpClient, RequestParams 和AsyncHttpResponseHandler相关java文献获得更多细节
5. AsyncHttpClient, RequestParams ,AsyncHttpResponseHandler三个类使用方法
(1)AsyncHttpClient
public class AsyncHttpClient extends java.lang.Object
该类通常用在android应用程序中创建异步GET, POST, PUT和DELETE HTTP请求,请求参数通过RequestParams实例创建,响应通过重写匿名内部类 ResponseHandlerInterface的方法处理。
例子:
- AsyncHttpClient client = new AsyncHttpClient();
- client.get("http://www.google.com", new ResponseHandlerInterface() {
- @Override
- public void onSuccess(String response) {
- System.out.println(response);
- }
- });
public class RequestParams extends java.lang.Object
用于创建AsyncHttpClient实例中的请求参数(包括字符串或者文件)的集合
例子:
- RequestParams params = new RequestParams();
- params.put("username", "james");
- params.put("password", "123456");
- params.put("email", "my@email.com");
- params.put("profile_picture", new File("pic.jpg")); // Upload a File
- params.put("profile_picture2", someInputStream); // Upload an InputStream
- params.put("profile_picture3", new ByteArrayInputStream(someBytes)); // Upload some bytes
- Map<String, String> map = new HashMap<String, String>();
- map.put("first_name", "James");
- map.put("last_name", "Smith");
- params.put("user", map); // url params: "user[first_name]=James&user[last_name]=Smith"
- Set<String> set = new HashSet<String>(); // unordered collection
- set.add("music");
- set.add("art");
- params.put("like", set); // url params: "like=music&like=art"
- List<String> list = new ArrayList<String>(); // Ordered collection
- list.add("Java");
- list.add("C");
- params.put("languages", list); // url params: "languages[]=Java&languages[]=C"
- String[] colors = { "blue", "yellow" }; // Ordered collection
- params.put("colors", colors); // url params: "colors[]=blue&colors[]=yellow"
- List<Map<String, String>> listOfMaps = new ArrayList<Map<String, String>>();
- Map<String, String> user1 = new HashMap<String, String>();
- user1.put("age", "30");
- user1.put("gender", "male");
- Map<String, String> user2 = new HashMap<String, String>();
- user2.put("age", "25");
- user2.put("gender", "female");
- listOfMaps.add(user1);
- listOfMaps.add(user2);
- params.put("users", listOfMaps); // url params: "users[][age]=30&users[][gender]=male&users[][age]=25&users[][gender]=female"
- AsyncHttpClient client = new AsyncHttpClient();
- client.post("http://myendpoint.com", params, responseHandler);
用于拦截和处理由AsyncHttpClient创建的请求。在匿名类AsyncHttpResponseHandler中的重写 onSuccess(int, org.apache.http.Header[], byte[])方法用于处理响应成功的请求。此外,你也可以重写 onFailure(int, org.apache.http.Header[], byte[], Throwable), onStart(), onFinish(), onRetry() 和onProgress(int, int)方法
例子:
- AsyncHttpClient client = new AsyncHttpClient();
- client.get("http://www.google.com", new AsyncHttpResponseHandler() {
- @Override
- public void onStart() {
- // Initiated the request
- }
- @Override
- public void onSuccess(int statusCode, Header[] headers, byte[] responseBody) {
- // Successfully got a response
- }
- @Override
- public void onFailure(int statusCode, Header[] headers, byte[] responseBody, Throwable error)
- {
- // Response failed :(
- }
- @Override
- public void onRetry() {
- // Request was retried
- }
- @Override
- public void onProgress(int bytesWritten, int totalSize) {
- // Progress notification
- }
- @Override
- public void onFinish() {
- // Completed the request (either success or failure)
- }
- });
6.利用PersistentCookieStore持久化存储cookie
PersistentCookieStore类用于实现Apache HttpClient的CookieStore接口,可以自动的将cookie保存到Android设备的SharedPreferences中,如果你打算使用cookie来管理验证会话,这个非常有用,因为用户可以保持登录状态,不管关闭还是重新打开你的app
(1)首先创建 AsyncHttpClient实例对象
- AsyncHttpClient myClient = new AsyncHttpClient();
- PersistentCookieStore myCookieStore = new PersistentCookieStore(this);
- myClient.setCookieStore(myCookieStore);
- BasicClientCookie newCookie = new BasicClientCookie("cookiesare", "awesome");
- newCookie.setVersion(1);
- newCookie.setDomain("mydomain.com");
- newCookie.setPath("/");
- myCookieStore.addCookie(newCookie);
7.利用RequestParams上传文件
类RequestParams支持multipart file 文件上传
(1)在RequestParams 对象中添加InputStream用于上传
- InputStream myInputStream = blah;
- RequestParams params = new RequestParams();
- params.put("secret_passwords", myInputStream, "passwords.txt");
- File myFile = new File("/path/to/file.png");
- RequestParams params = new RequestParams();
- try {
- params.put("profile_picture", myFile);
- } catch(FileNotFoundException e) {}
- byte[] myByteArray = blah;
- RequestParams params = new RequestParams();
- params.put("soundtrack", new ByteArrayInputStream(myByteArray), "she-wolf.mp3");
8.用BinaryHttpResponseHandler下载二进制数据
- BinaryHttpResponseHandler用于获取二进制数据如图片和其他文件
- AsyncHttpClient client = new AsyncHttpClient();
- String[] allowedContentTypes = new String[] { "image/png", "image/jpeg" };
- client.get("http://example.com/file.png", new BinaryHttpResponseHandler(allowedContentTypes) {
- @Override
- public void onSuccess(byte[] fileData) {
- // Do something with the file
- }
- });
http://loopj.com/android-async-http/