先来看一下最基本的用法
AsyncHttpClient client = new AsyncHttpClient(); client.get("http://www.google.com", new AsyncHttpResponseHandler() { @Override public void onSuccess(String response) { System.out.println(response); } });
通过AsyncHttpClient类的实例就可以执行网络请求,包括get、put、post、head、delete。并指定一个ResponseHandlerInterface的实例接收请求结果。(onSuccess参数不对,此处只说明基本用法,详细参数看源码)
主要类介绍
- AsyncHttpRequest
继承自Runnabler,被submit至线程池执行网络请求并发送start,success等消息
- AsyncHttpResponseHandler
接收请求结果,一般重写onSuccess及onFailure接收请求成功或失败的消息,还有onStart,onFinish等消息
- TextHttpResponseHandler
继承自AsyncHttpResponseHandler,只是重写了AsyncHttpResponseHandler的onSuccess和onFailure方法,将请求结果由byte数组转换为String
- JsonHttpResponseHandler
继承自TextHttpResponseHandler,同样是重写onSuccess和onFailure方法,将请求结果由String转换为JSONObject或JSONArray
- BaseJsonHttpResponseHandler
继承自TextHttpResponseHandler,是一个泛型类,提供了parseResponse方法,子类需要提供实现,将请求结果解析成需要的类型,子类可以灵活地使用解析方法,可以直接原始解析,使用gson等。
- RequestParams
请求参数,可以添加普通的字符串参数,并可添加File,InputStream上传文件
- AsyncHttpClient
核心类,使用HttpClient执行网络请求,提供了get,put,post,delete,head等请求方法,使用起来很简单,只需以url及RequestParams调用相应的方法即可,还可以选择性地传入Context,用于取消Content相关的请求,同时必须提供ResponseHandlerInterface(AsyncHttpResponseHandler继承自ResponseHandlerInterface)的实现类,一般为AsyncHttpResponseHandler的子类,AsyncHttpClient内部有一个线程池,当使用AsyncHttpClient执行网络请求时,最终都会调用sendRequest方法,在这个方法内部将请求参数封装成AsyncHttpRequest(继承自Runnable)交由内部的线程池执行。
- SyncHttpClient
继承自AsyncHttpClient,同步执行网络请求,AsyncHttpClient把请求封装成AsyncHttpRequest后提交至线程池,SyncHttpClient把请求封装成AsyncHttpRequest后直接调用它的run方法。
请求流程
- 调用AsyncHttpClient的get或post等方法发起网络请求
- 所有的请求都走了sendRequest,在sendRequest中把请求封装为了AsyncHttpRequest,并添加到线程池执行
- 当请求被执行时(即AsyncHttpRequest的run方法),执行AsyncHttpRequest的makeRequestWithRetries方法执行实际的请求,当请求失败时可以重试。并在请求开始,结束,成功或失败时向请求时传的ResponseHandlerInterface实例发送消息
- 基本上使用的都是AsyncHttpResponseHandler的子类,调用其onStart,onSuccess等方法返回请求结果
详细使用方法
官方建议使用一个静态的AsyncHttpClient,像下面的这样:
public class TwitterRestClient { private static final String BASE_URL = "http://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; } }
封装的方法建议都加上Context参数,以在Activity pause或stop时取消掉没用的请求。
详细使用方法就不说了,直接看官方文档
其他说明及总结
Android-Async-Http的使用非常简单,通过AsyncHttpClient发起请求就可以了,如果需要添加参数,直接传一个RequestParams过去,而且参数可以是String、File和InputStream,可以很方便地上传文件。
每个请求都需要传一个ResponseHandlerInterface的实例用以接收请求结果或请求失败,请求结束等通知,一般是AsyncHttpResponseHandler的子类。
通过BinaryHttpResponseHandler可以发起二进制请求,如请求图片。
通过TextHttpResponseHandler可以发起返回结果为字符串的请求,一般这个使用较多。
也可以使用它的子类JsonHttpResponseHandler,返回结果是一个JSONObject或JSONArray。不过感觉这个类作用不大,一是有另一个类BaseJsonHttpResponseHandler,可以直接解析返回的JSON数据,二是JsonHttpResponseHandler的方法太复杂了,有太多的onSuccess和onFailure方法,都不知道重写哪个了。
如上图所示,每个子类有太多的onSuccess和onFailure了,尤其是JsonHttpResponseHandler,这应该算是这个类库的不足吧。所以平时使用时基本不使用JsonHttpResponseHandler,而是直接使用TextHttpResponseHandler,当然也可以使用BaseJsonHttpResponseHandler。
这个类库还有一点不足,就是onSuccess等方法一般会在主线程执行,其实这么说不严谨,看代码吧:
public AsyncHttpResponseHandler() { boolean missingLooper = null == Looper.myLooper(); // Try to create handler if (!missingLooper) handler = new ResponderHandler(this); else { // There is no Looper on this thread so synchronous mode should be used. handler = null; setUseSynchronousMode(true); Log.i(LOG_TAG, "Current thread has not called Looper.prepare(). Forcing synchronous mode."); } // Init Looper by calling postRunnable without an argument. postRunnable(null); }
可以看到,内部使用了Handler,当新建AsyncHttpResponseHandler的实例的时候会获取当前线程的Looper,如果为空就启用同步模式,即所有的回调都会在执行请求的线程中执行,当在一个普通的后台线程时这样执行是正常的,而我们一般都会在主线程发请请求,结果就是所有的回调都会在主线程中执行,这就限制了我们在onSuccess中执行耗时操作,比如请求成功后将数据持久化到数据库。
不过可以看到创建Handler的时候使用了Looper对象,所以我们就可以改进一下其构造函数,添加一个Looper参数(同步修改子类),这样所有的回调就都会在Looper所在线程执行,这样我们只需要开启一个HandlerThread就行了。但这样和Looper为空时一样有一个弊端,如果要更新UI操作的话,还需要向一个主线程的Handler发送消息让UI更新。还有第二个弊端,所有回调都在同一个HandlerThread中执行,如果一个处理耗时太久会阻塞后面的请求结果处理,如果只是简单地写个数据库影响应该不大,如果真耗时太久,为这个耗时处理再开个线程吧。
出处: www.cnblogs.com/angeldevil
转载请注明出处!
2.特性
(1)采用异步http请求,并通过匿名内部类处理回调结果
(2)http请求独立在UI主线程之外
(3)采用线程池来处理并发请求
(4)采用RequestParams类创建GET/POST参数
(5)不需要第三方包即可支持Multipart file文件上传
(6)大小只有25kb
(7)自动为各种移动电话处理连接断开时请求重连
(8)超快的自动gzip响应解码支持
(9)使用BinaryHttpResponseHandler类下载二进制文件(如图片)
(10) 使用JsonHttpResponseHandler类可以自动将响应结果解析为json格式
(11)持久化cookie存储,可以将cookie保存到你的应用程序的SharedPreferences中
3.使用方法
(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("http://www.google.com", new AsyncHttpResponseHandler() {
- @Override
- public void onSuccess(String response) {
- System.out.println(response);
- }
- });
4.建议使用静态的Http Client对象
在下面这个例子,我们创建了静态的http client对象,使其很容易连接到Twitter的API
- import com.loopj.android.http.*;
- public class TwitterRestClient {
- private static final String BASE_URL = "http://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;
- }
- }
- 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(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);
- }
- });
- }
- }
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
- }
- });
- ------------------------------------------------------------------------------------------
android-async-http 开源框架可以使我们轻松地获取网络数据或者向服务器发送数据,最关键的是,它是异步框架,在底层使用线程池处理并发请求,效率很高,使用又特别简单。
以往我们在安卓上做项目,比如要下载很多图片、网页或者其他的资源,多数开发者会选择一个线程一个下载任务这种模型,因为安卓自带的 AndroidHttpClient 或者 java 带的 java.net.URL ,默认都是阻塞式操作。这种模型效率不高,对并发要求高的 APP 来讲,并不适用。有的人会选择使用 nio 自己实现,代码复杂度又很高。
AsyncHttpClient 作为 android-async-http 框架的一个核心应用类,使用简单,可以处理文本、二进制等各种格式的 web 资源。下面提供一些代码来看如何使用:
- public class Downloader {
- public static AsyncHttpClient mHttpc = new AsyncHttpClient();
- public static String TAG = "Downloader";
- public void downloadText(String uri){
- mHttpc.get(uri, null, new AsyncHttpResponseHandler(){
- @Override
- public void onSuccess(String data){
- Log.i(TAG, "downloaded, thread id " + Thread.currentThread().getId());
- // TODO: do something on
- }
- @Override
- public void onFailure(Throwable e, String data){
- Log.i(TAG, "download failed.");
- // TODO: error proceed
- }
- });
- }
- public void downloadImage(String uri, String savePath){
- mHttpc.get(uri, new ImageResponseHandler(savePath));
- }
- public class ImageResponseHandler extends BinaryHttpResponseHandler{
- private String mSavePath;
- public ImageResponseHandler(String savePath){
- super();
- mSavePath = savePath;
- }
- @Override
- public void onSuccess(byte[] data){
- Log.i(TAG, "download image, file length " + data.length);
- // TODO: save image , do something on image
- }
- @Override
- public void onFailure(Throwable e, String data){
- Log.i(TAG, "download failed");
- // TODO : error proceed
- }
- }
- };
上面的代码演示了如何使用 AsyncHttpResponseHandler 和 BinaryHttpResponseHandler ,相信 AsyncHttpClient 会给大家带来很大的便利。