快速Android开发系列网络篇之Android-Async-Http

来源:互联网 发布:乐视手机4g网络设置 编辑:程序博客网 时间:2024/05/28 05:19

先来看一下最基本的用法

复制代码
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方法。

请求流程

  1. 调用AsyncHttpClient的get或post等方法发起网络请求
  2. 所有的请求都走了sendRequest,在sendRequest中把请求封装为了AsyncHttpRequest,并添加到线程池执行
  3. 当请求被执行时(即AsyncHttpRequest的run方法),执行AsyncHttpRequest的makeRequestWithRetries方法执行实际的请求,当请求失败时可以重试。并在请求开始,结束,成功或失败时向请求时传的ResponseHandlerInterface实例发送消息
  4. 基本上使用的都是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中执行,如果一个处理耗时太久会阻塞后面的请求结果处理,如果只是简单地写个数据库影响应该不大,如果真耗时太久,为这个耗时处理再开个线程吧。

 

作者:AngelDevil
出处:www.cnblogs.com/angeldevil

欢迎访问我的个人站点:angeldevil.me

转载请注明出处!


 1.简介
Android中网络请求一般使用Apache HTTP Client或者采用HttpURLConnect,但是直接使用这两个类库需要写大量的代码才能完成网络post和get请求,而使用android-async-http这个库可以大大的简化操作,它是基于Apache’s HttpClient ,所有的请求都是独立在UI主线程之外,通过回调方法处理请求结果,采用android  Handler message 机制传递信息。

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)创建异步请求

[java] view plaincopy
  1. AsyncHttpClient client = new AsyncHttpClient();  
  2. client.get("http://www.google.com"new AsyncHttpResponseHandler() {  
  3.     @Override  
  4.     public void onSuccess(String response) {  
  5.         System.out.println(response);  
  6.     }  
  7. });  

4.建议使用静态的Http Client对象
在下面这个例子,我们创建了静态的http client对象,使其很容易连接到Twitter的API
[java] view plaincopy
  1. import com.loopj.android.http.*;  
  2.   
  3. public class TwitterRestClient {  
  4.   private static final String BASE_URL = "http://api.twitter.com/1/";  
  5.   
  6.   private static AsyncHttpClient client = new AsyncHttpClient();  
  7.   
  8.   public static void get(String url, RequestParams params, AsyncHttpResponseHandler responseHandler) {  
  9.       client.get(getAbsoluteUrl(url), params, responseHandler);  
  10.   }  
  11.   
  12.   public static void post(String url, RequestParams params, AsyncHttpResponseHandler responseHandler) {  
  13.       client.post(getAbsoluteUrl(url), params, responseHandler);  
  14.   }  
  15.   
  16.   private static String getAbsoluteUrl(String relativeUrl) {  
  17.       return BASE_URL + relativeUrl;  
  18.   }  
  19. }  
然后我们可以很容易的在代码中操作Twitter的API
[java] view plaincopy
  1. import org.json.*;  
  2. import com.loopj.android.http.*;  
  3.   
  4. class TwitterRestClientUsage {  
  5.     public void getPublicTimeline() throws JSONException {  
  6.         TwitterRestClient.get("statuses/public_timeline.json"nullnew JsonHttpResponseHandler() {  
  7.             @Override  
  8.             public void onSuccess(JSONArray timeline) {  
  9.                 // Pull out the first event on the public timeline  
  10.                 JSONObject firstEvent = timeline.get(0);  
  11.                 String tweetText = firstEvent.getString("text");  
  12.   
  13.                 // Do something with the response  
  14.                 System.out.println(tweetText);  
  15.             }  
  16.         });  
  17.     }  
  18. }  

5. AsyncHttpClient, RequestParams ,AsyncHttpResponseHandler三个类使用方法

(1)AsyncHttpClient

public class AsyncHttpClient extends java.lang.Object
 该类通常用在android应用程序中创建异步GET, POST, PUT和DELETE HTTP请求,请求参数通过RequestParams实例创建,响应通过重写匿名内部类 ResponseHandlerInterface的方法处理。
例子:
[java] view plaincopy
  1. AsyncHttpClient client = new AsyncHttpClient();  
  2.  client.get("http://www.google.com"new ResponseHandlerInterface() {  
  3.      @Override  
  4.      public void onSuccess(String response) {  
  5.          System.out.println(response);  
  6.      }  
  7.  });  
(2)RequestParams
public class RequestParams extends java.lang.Object 
用于创建AsyncHttpClient实例中的请求参数(包括字符串或者文件)的集合
例子:
[java] view plaincopy
  1. RequestParams params = new RequestParams();  
  2.  params.put("username""james");  
  3.  params.put("password""123456");  
  4.  params.put("email""my@email.com");  
  5.  params.put("profile_picture"new File("pic.jpg")); // Upload a File  
  6.  params.put("profile_picture2", someInputStream); // Upload an InputStream  
  7.  params.put("profile_picture3"new ByteArrayInputStream(someBytes)); // Upload some bytes  
  8.   
  9.  Map<String, String> map = new HashMap<String, String>();  
  10.  map.put("first_name""James");  
  11.  map.put("last_name""Smith");  
  12.  params.put("user", map); // url params: "user[first_name]=James&user[last_name]=Smith"  
  13.   
  14.  Set<String> set = new HashSet<String>(); // unordered collection  
  15.  set.add("music");  
  16.  set.add("art");  
  17.  params.put("like", set); // url params: "like=music&like=art"  
  18.   
  19.  List<String> list = new ArrayList<String>(); // Ordered collection  
  20.  list.add("Java");  
  21.  list.add("C");  
  22.  params.put("languages", list); // url params: "languages[]=Java&languages[]=C"  
  23.   
  24.  String[] colors = { "blue""yellow" }; // Ordered collection  
  25.  params.put("colors", colors); // url params: "colors[]=blue&colors[]=yellow"  
  26.   
  27.  List<Map<String, String>> listOfMaps = new ArrayList<Map<String, String>>();  
  28.  Map<String, String> user1 = new HashMap<String, String>();  
  29.  user1.put("age""30");  
  30.  user1.put("gender""male");  
  31.  Map<String, String> user2 = new HashMap<String, String>();  
  32.  user2.put("age""25");  
  33.  user2.put("gender""female");  
  34.  listOfMaps.add(user1);  
  35.  listOfMaps.add(user2);  
  36.  params.put("users", listOfMaps); // url params: "users[][age]=30&users[][gender]=male&users[][age]=25&users[][gender]=female"  
  37.   
  38.  AsyncHttpClient client = new AsyncHttpClient();  
  39.  client.post("http://myendpoint.com", params, responseHandler);  
(3)public class AsyncHttpResponseHandler extends java.lang.Object implements ResponseHandlerInterface
用于拦截和处理由AsyncHttpClient创建的请求。在匿名类AsyncHttpResponseHandler中的重写 onSuccess(int, org.apache.http.Header[], byte[])方法用于处理响应成功的请求。此外,你也可以重写 onFailure(int, org.apache.http.Header[], byte[], Throwable), onStart(), onFinish(), onRetry() 和onProgress(int, int)方法
例子:
[java] view plaincopy
  1. AsyncHttpClient client = new AsyncHttpClient();  
  2.  client.get("http://www.google.com"new AsyncHttpResponseHandler() {  
  3.      @Override  
  4.      public void onStart() {  
  5.          // Initiated the request  
  6.      }  
  7.   
  8.      @Override  
  9.      public void onSuccess(int statusCode, Header[] headers, byte[] responseBody) {  
  10.          // Successfully got a response  
  11.      }  
  12.   
  13.      @Override  
  14.      public void onFailure(int statusCode, Header[] headers, byte[] responseBody, Throwable error)  
  15.  {  
  16.          // Response failed :(  
  17.      }  
  18.   
  19.      @Override  
  20.      public void onRetry() {  
  21.          // Request was retried  
  22.      }  
  23.   
  24.      @Override  
  25.      public void onProgress(int bytesWritten, int totalSize) {  
  26.          // Progress notification  
  27.      }  
  28.   
  29.      @Override  
  30.      public void onFinish() {  
  31.          // Completed the request (either success or failure)  
  32.      }  
  33.  });  

6.利用PersistentCookieStore持久化存储cookie
PersistentCookieStore类用于实现Apache HttpClient的CookieStore接口,可以自动的将cookie保存到Android设备的SharedPreferences中,如果你打算使用cookie来管理验证会话,这个非常有用,因为用户可以保持登录状态,不管关闭还是重新打开你的app
(1)首先创建 AsyncHttpClient实例对象
[java] view plaincopy
  1. AsyncHttpClient myClient = new AsyncHttpClient();  
(2)将客户端的cookie保存到PersistentCookieStore实例对象,带有activity或者应用程序context的构造方法
[java] view plaincopy
  1. PersistentCookieStore myCookieStore = new PersistentCookieStore(this);  
  2. myClient.setCookieStore(myCookieStore);  
(3)任何从服务器端获取的cookie都会持久化存储到myCookieStore中,添加一个cookie到存储中,只需要构造一个新的cookie对象,并且调用addCookie方法
[java] view plaincopy
  1. BasicClientCookie newCookie = new BasicClientCookie("cookiesare""awesome");  
  2. newCookie.setVersion(1);  
  3. newCookie.setDomain("mydomain.com");  
  4. newCookie.setPath("/");  
  5. myCookieStore.addCookie(newCookie);  

7.利用RequestParams上传文件
类RequestParams支持multipart file 文件上传
(1)在RequestParams 对象中添加InputStream用于上传
[java] view plaincopy
  1. InputStream myInputStream = blah;  
  2. RequestParams params = new RequestParams();  
  3. params.put("secret_passwords", myInputStream, "passwords.txt");  
(2)添加文件对象用于上传
[java] view plaincopy
  1. File myFile = new File("/path/to/file.png");  
  2. RequestParams params = new RequestParams();  
  3. try {  
  4.     params.put("profile_picture", myFile);  
  5. catch(FileNotFoundException e) {}  
(3)添加字节数组用于上传
[java] view plaincopy
  1. byte[] myByteArray = blah;  
  2. RequestParams params = new RequestParams();  
  3. params.put("soundtrack"new ByteArrayInputStream(myByteArray), "she-wolf.mp3");  

8.用BinaryHttpResponseHandler下载二进制数据
[java] view plaincopy
  1. BinaryHttpResponseHandler用于获取二进制数据如图片和其他文件  
  2. AsyncHttpClient client = new AsyncHttpClient();  
  3. String[] allowedContentTypes = new String[] { "image/png""image/jpeg" };  
  4. client.get("http://example.com/file.png"new BinaryHttpResponseHandler(allowedContentTypes) {  
  5.     @Override  
  6.     public void onSuccess(byte[] fileData) {  
  7.         // Do something with the file  
  8.     }  
  9. });  
  10. ------------------------------------------------------------------------------------------

    android-async-http 开源框架可以使我们轻松地获取网络数据或者向服务器发送数据,最关键的是,它是异步框架,在底层使用线程池处理并发请求,效率很高,使用又特别简单。

        以往我们在安卓上做项目,比如要下载很多图片、网页或者其他的资源,多数开发者会选择一个线程一个下载任务这种模型,因为安卓自带的 AndroidHttpClient 或者 java 带的 java.net.URL ,默认都是阻塞式操作。这种模型效率不高,对并发要求高的 APP 来讲,并不适用。有的人会选择使用 nio 自己实现,代码复杂度又很高。

        AsyncHttpClient 作为 android-async-http 框架的一个核心应用类,使用简单,可以处理文本、二进制等各种格式的 web 资源。下面提供一些代码来看如何使用:

    [java] view plaincopy在CODE上查看代码片派生到我的代码片
    1. public class Downloader {  
    2.     public static AsyncHttpClient mHttpc = new AsyncHttpClient();  
    3.     public static String TAG = "Downloader";  
    4.       
    5.     public void downloadText(String uri){  
    6.         mHttpc.get(uri, nullnew AsyncHttpResponseHandler(){  
    7.             @Override  
    8.             public void onSuccess(String data){  
    9.                 Log.i(TAG, "downloaded, thread id " + Thread.currentThread().getId());  
    10.                 // TODO: do something on  
    11.             }  
    12.             @Override  
    13.             public void onFailure(Throwable e, String data){  
    14.                 Log.i(TAG, "download failed.");  
    15.                 // TODO: error proceed  
    16.             }  
    17.         });  
    18.     }  
    19.       
    20.     public void downloadImage(String uri, String savePath){  
    21.         mHttpc.get(uri, new ImageResponseHandler(savePath));  
    22.     }  
    23.       
    24.     public class ImageResponseHandler extends BinaryHttpResponseHandler{  
    25.         private String mSavePath;  
    26.           
    27.         public ImageResponseHandler(String savePath){  
    28.             super();  
    29.             mSavePath = savePath;  
    30.         }  
    31.         @Override  
    32.         public void onSuccess(byte[] data){  
    33.             Log.i(TAG, "download image, file length " + data.length);  
    34.             // TODO: save image , do something on image  
    35.         }  
    36.         @Override  
    37.         public void onFailure(Throwable e, String data){  
    38.             Log.i(TAG, "download failed");  
    39.             // TODO : error proceed  
    40.         }  
    41.     }  
    42. };  

        上面的代码演示了如何使用 AsyncHttpResponseHandler 和 BinaryHttpResponseHandler ,相信 AsyncHttpClient  会给大家带来很大的便利。
AsyncHttpClient框架下载地址:http://loopj.com/android-async-http/


0 0
原创粉丝点击