Android异步Http客户端适用于Android的基于回调的Http客户端库

我就是我 2022-03-19 04:52 320阅读 0赞

## 概观 ##

基于Apache的[HttpClient][]库构建的基于异步回调的Android Http客户端 。所有请求都是在应用程序的主UI线程之外发出的，但任何回调逻辑都将在使用Android的Handler消息传递创建回调的同一线程上执行。您也可以在Service或后台线程中使用它，库将自动识别在哪个上下文中运行。

*如果您还在寻找一个很棒的[安卓崩溃报告][Link 1]服务，我还建议您查看我的公司[Bugsnag][]。*

## 特征 ##

*  使用版本4.3.6的上游HttpClient代替Android提供了DefaultHttpClient
 *  与Android **API 23**及更高版本兼容
 *  发出**异步** HTTP请求，处理**匿名回调中的**响应
 *  HTTP请求发生**在UI线程之外**
 *  请求使用线程**池**来限制并发资源使用
 *  GET / POST **参数构建器**（RequestParams）
 *  **多部分文件上载**，没有其他第三方库
 *  **流式JSON上传**，没有其他库
 *  处理循环和相对重定向
 *  应用程序的小型开销，一切只需**90kb**
 *  针对不稳定的移动连接优化的自动智能**请求重试**
 *  自动**gzip**响应解码支持超快请求
 *  二进制协议通信 `BinaryHttpResponseHandler`
 *  内置响应解析成**JSON** 与`JsonHttpResponseHandler`
 *  将响应直接保存到文件中 `FileAsyncHttpResponseHandler`
 *  **持久性cookie存储**，将cookie保存到应用程序的SharedPreferences中
 *  与Jackson JSON，Gson或其他JSON（de）序列化库集成 `BaseJsonHttpResponseHandler`
 *  支持SAX解析器 `SaxAsyncHttpResponseHandler`
 *  支持语言和内容编码，而不仅仅是UTF-8

## 用于顶级应用程序和开发人员的生产 ##

[Instagram的][Instagram]

Instagram是Android上排名第一的照片应用程序，拥有超过1000万用户

[Pinterest的][Pinterest]

流行的在线插板。组织和分享您喜爱的事物。

[前线突击队（Glu游戏）][Glu]

Glu Games在Android上排名第一的人物射击游戏。

[Heyzap][]

具有数百万用户的社交游戏发现应用

[提出][Link 2]

Pose是分享和发现新款式的首选时尚应用

[数以千计的应用......][......]

数以千计的顶级应用程序在生产中使用异步HTTP。

## 安装和基本用法 ##

使用格式的Gradle buildscript添加maven依赖项

dependencies { 
      compile 'com.loopj.android:android-async-http:1.4.9'
    }

导入http包。

import com.loopj.android.http.*;

创建一个新`AsyncHttpClient`实例并发出请求：

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
    	}
    });

## 推荐用法：创建一个静态Http客户端 ##

在这个例子中，我们将使用静态访问器创建一个http客户端类，以便与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][] Javadocs。

## 持久性Cookie存储 `PersistentCookieStore` ##

该库还包括一个`PersistentCookieStore`Apache HttpClient `CookieStore`接口的实现，它自动将cookie保存到`SharedPreferences`Android设备上的存储中。

如果您想使用cookie来管理身份验证会话，这非常有用，因为即使在关闭并重新打开您的应用程序后，用户仍将保持登录状态。

首先，创建一个实例`AsyncHttpClient`：

AsyncHttpClient myClient = new AsyncHttpClient();

现在将此客户端的cookie存储设置为一个新实例 `PersistentCookieStore`，使用活动或应用程序上下文构建（通常`this`就足够了）：

PersistentCookieStore myCookieStore = new PersistentCookieStore(this);
    myClient.setCookieStore(myCookieStore);

从服务器收到的任何cookie现在都将存储在持久性cookie存储中。

要将自己的cookie添加到商店，只需构建一个新的cookie并调用`addCookie`：

BasicClientCookie newCookie = new BasicClientCookie("cookiesare", "awesome");
    newCookie.setVersion(1);
    newCookie.setDomain("mydomain.com");
    newCookie.setPath("/");
    myCookieStore.addCookie(newCookie);

有关 更多信息，请参见[PersistentCookieStore Javadoc][]。

## 使用添加GET / POST参数 `RequestParams` ##

在`RequestParams`类用于可选的GET或POST参数添加到您的要求。`RequestParams`可以通过各种方式构建和构建：

创建为空`RequestParams`并立即添加一些参数：

RequestParams params = new RequestParams();
    params.put("key", "value");
    params.put("more", "data");

创建`RequestParams`单个参数：

RequestParams params = new RequestParams("single", "value");

创建`RequestParams`从现有的`Map`键/值的字符串：

HashMap<String, String> paramMap = new HashMap<String, String>();
    paramMap.put("key", "value");
    RequestParams params = new RequestParams(paramMap);

有关 更多信息，请参阅[RequestParams Javadoc][RequestParams]。

## 上传文件 `RequestParams` ##

该`RequestParams`班还支持多文件上传，如下所示：

添加`InputStream`到`RequestParams`要上传：

InputStream myInputStream = blah;
    RequestParams params = new RequestParams();
    params.put("secret_passwords", myInputStream, "passwords.txt");

添加要上载的`File`对象`RequestParams`：

File myFile = new File("/path/to/file.png");
    RequestParams params = new RequestParams();
    try { 
        params.put("profile_picture", myFile);
    } catch(FileNotFoundException e) {}

添加一个字节数组`RequestParams`到上传：

byte[] myByteArray = blah;
    RequestParams params = new RequestParams();
    params.put("soundtrack", new ByteArrayInputStream(myByteArray), "she-wolf.mp3");

有关 更多信息，请参阅[RequestParams Javadoc][RequestParams]。

## 下载二进制数据 `FileAsyncHttpResponseHandler` ##

的`FileAsyncHttpResponseHandler`类可以用来获取的二进制数据，如图像和其他文件。例如：

AsyncHttpClient client = new AsyncHttpClient();
    client.get("https://example.com/file.png", new FileAsyncHttpResponseHandler(/* Context */ this) { 
        @Override
        public void onSuccess(int statusCode, Header[] headers, File response) { 
            // Do something with the file `response`
        }
    });

有关 更多信息，请参阅[FileAsyncHttpResponseHandler Javadoc][]。

## 添加HTTP Basic Auth凭据 ##

在处理使用HTTP基本访问身份验证请求的API服务时，某些请求可能需要用户名/密码凭据。您可以使用该方法`setBasicAuth()`提供凭据。

为特定请求设置任何主机和领域的用户名/密码。默认情况下，身份验证范围适用于任何主机，端口和领域。

AsyncHttpClient client = new AsyncHttpClient();
    client.setBasicAuth("username","password/token");
    client.get("https://example.com");

您还可以提供更具体的身份验证范围（推荐）

AsyncHttpClient client = new AsyncHttpClient();
    client.setBasicAuth("username","password", new AuthScope("example.com", 80, AuthScope.ANY_REALM));
    client.get("https://example.com");

有关 更多信息，请参阅[RequestParams Javadoc][AsyncHttpClient]。

## 在设备上测试 ##

您可以使用提供的示例应用程序在真实设备或仿真器上测试库。示例应用程序实现了库的所有重要功能，您可以将其用作灵感源。

示例应用程序的源代码：[https][]：[//github.com/loopj/android-async-http/tree/master/sample][https]

要运行示例应用程序，请克隆android-async-http github存储库并在其根目录中运行命令：

gradle :sample:installDebug

哪个将在连接的设备上安装Sample应用程序，所有示例都会立即生效，如果没有请在[https://github.com/loopj/android-async-http/issues][https_github.com_loopj_android-async-http_issues]上提交错误报告

## 从Source构建 ##

要从`.jar`源构建文件，首先要复制android-async-http github存储库。然后你必须安装Android SDK和Gradle buildscript，然后运行：

gradle :library:jarRelease

这将在路径中生成一个文件`{repository_root}/library/build/libs/library-1.4.9.jar`。

## 报告错误或功能请求 ##

请在此项目的github问题页面上报告任何错误或功能请求：

[https://github.com/loopj/android-async-http/issues][https_github.com_loopj_android-async-http_issues]

## 学分和贡献者 ##

詹姆斯史密斯（[https://github.com/loopj][https_github.com_loopj]）

创作者和维护者

Marek Sebera（[https://github.com/smarek][https_github.com_smarek]）

维护人员自1.4.4发布以来

Noor Dawod（[https://github.com/fineswap][https_github.com_fineswap]）

维护人员自1.4.5发布以来

Luciano Vitti（[https://github.com/xAnubiSx][https_github.com_xAnubiSx]）

合作样本申请

Jason Choy（[https://github.com/jjwchoy][https_github.com_jjwchoy]）

添加了对RequestHandle功能的支持

Micah Fivecoate（[https://github.com/m5][https_github.com_m5]）

主要贡献者，包括原件 `RequestParams`

Droid Fu项目（[https://github.com/kaeppler/droid-fu][https_github.com_kaeppler_droid-fu]）

更好的http重试的灵感和代码

Rafael Sanches（[https://blog.rafaelsanches.com][https_blog.rafaelsanches.com]）

原始`SimpleMultipartEntity`代码

Anthony Persaud（[https://github.com/apersaud][https_github.com_apersaud]）

添加了对HTTP Basic身份验证请求的支持。

Linden Darling（[https://github.com/coreform][https_github.com_coreform]）

添加了对二进制/图像响应的支持

许多其他人，贡献列在许可证标题中的每个文件中。您还可以通过查看[Github][]上的项目提交，问题和拉取请求来查找贡献者

## 执照 ##

Android Asynchronous Http Client是在Android友好的Apache License 2.0版下发布的。阅读完整许可证：

[https://www.apache.org/licenses/LICENSE-2.0][https_www.apache.org_licenses_LICENSE-2.0]

## 关于作者 ##

詹姆斯史密斯，英国企业家和开发人员，总部设在旧金山。

我是[Bugsnag][]与 [Simon Maynard][]的联合创始人，从2009年到2012年，我担任产品团队的[Heyzap][Heyzap 1]首席技术官。

[关注@loopj][loopj]

[HttpClient]: https://hc.apache.org/httpcomponents-client-ga/
[Link 1]: https://bugsnag.com/platforms/android
[Bugsnag]: https://bugsnag.com/
[Instagram]: https://play.google.com/store/apps/details?id=com.instagram.android
[Pinterest]: https://play.google.com/store/apps/details?id=com.pinterest
[Glu]: https://play.google.com/store/apps/details?id=com.glu.modwarsniper
[Heyzap]: https://market.android.com/details?id=com.heyzap.android
[Link 2]: https://market.android.com/details?id=com.pose
[......]: https://www.appbrain.com/stats/libraries/details/loopj_asynchttpclient/android-asynchronous-http-client
[AsyncHttpClient]: https://loopj.com/android-async-http/doc/com/loopj/android/http/AsyncHttpClient.html
[RequestParams]: https://loopj.com/android-async-http/doc/com/loopj/android/http/RequestParams.html
[AsyncHttpResponseHandler]: https://loopj.com/android-async-http/doc/com/loopj/android/http/AsyncHttpResponseHandler.html
[PersistentCookieStore Javadoc]: https://loopj.com/android-async-http/doc/com/loopj/android/http/PersistentCookieStore.html
[FileAsyncHttpResponseHandler Javadoc]: https://loopj.com/android-async-http/doc/com/loopj/android/http/FileAsyncHttpResponseHandler.html
[https]: https://github.com/loopj/android-async-http/tree/master/sample
[https_github.com_loopj_android-async-http_issues]: https://github.com/loopj/android-async-http/issues
[https_github.com_loopj]: https://github.com/loopj
[https_github.com_smarek]: https://github.com/smarek
[https_github.com_fineswap]: https://github.com/fineswap
[https_github.com_xAnubiSx]: https://github.com/xAnubiSx
[https_github.com_jjwchoy]: https://github.com/jjwchoy
[https_github.com_m5]: https://github.com/m5
[https_github.com_kaeppler_droid-fu]: https://github.com/kaeppler/droid-fu
[https_blog.rafaelsanches.com]: https://blog.rafaelsanches.com/
[https_github.com_apersaud]: https://github.com/apersaud
[https_github.com_coreform]: https://github.com/coreform
[Github]: https://github.com/loopj/android-async-http/commits/master
[https_www.apache.org_licenses_LICENSE-2.0]: https://www.apache.org/licenses/LICENSE-2.0
[Simon Maynard]: http://snmaynard.com/
[Heyzap 1]: http://www.heyzap.com/
[loopj]: https://twitter.com/loopj