如何高效的使用Okhttp

Question

如题所述

Answer 1

OkHttp 是一个在开发可汗学院Android APP过程中非常重要的依赖库。它的默认的配置为我们提供了非常重要实用功能，下面一些步骤我们可以让Okhttp提供更多功能使用灵活和内省能力。

1. 启用文件系统上的响应缓存

默认情况下，Okhttp不支持响应缓存，包括HTTP Cache-Control头允许缓存响应。因此，客户端通过一次又一次的请求相同的资源浪费时间和带宽。而不是简单地读取初始响应后缓存的副本。

要在文件系统中启用响应缓存，需要配置com.squareup.okhttp.Cache实例，并把它传递给你的OkHttpClient实例的setCache方法。你必须初始化缓存与存放目录的文件，并以字节为单位的最大值。

响应返回数据可以写入给定目录文件，如果一个响应的缓存超过了给定的大小。我们可以采取 LRU policy 。

我们可以在 stackoverflow 查看 Jesse Wilson 的回复。我们可以通过context.getCacheDir()在子目录中缓存我们的响应：

// Base directory recommended by http://stackoverflow.com/a/32752861/400717.
// Guard against null, which is possible according to
// https://groups.google.com/d/msg/android-developers/-694j87eXVU/YYs4b6kextwJ and
// http://stackoverflow.com/q/4441849/400717.
final @Nullable File baseDir = context.getCacheDir();
if (baseDir != null) {
final File cacheDir = new File(baseDir, "HttpResponseCache");
okHttpClient.setCache(new Cache(cacheDir, HTTP_RESPONSE_DISK_CACHE_MAX_SIZE));
}

// Base directory recommended by http://stackoverflow.com/a/32752861/400717.
// Guard against null, which is possible according to
// https://groups.google.com/d/msg/android-developers/-694j87eXVU/YYs4b6kextwJ and
// http://stackoverflow.com/q/4441849/400717.
final @NullableFilebaseDir = context.getCacheDir();
if (baseDir != null) {
final FilecacheDir = new File(baseDir, "HttpResponseCache");
okHttpClient.setCache(new Cache(cacheDir, HTTP_RESPONSE_DISK_CACHE_MAX_SIZE));
}

在可汗学院的程序中我们指定 HTTP_RESPONSE_DISK_CACHE_MAX_SIZE as 10 * 1024 * 1024 , or 10 MB的大小

2. 集成Stetho

Stetho 是Facebook的一个可爱的库，可以使用Chrome浏览器的Chrome开发人员工具功能来检查你的Andr oid应用程序。

Stetho除了允许你检查你的应用程序的SQLite数据库，还可以查看View的层次结构。允许你检查由OkHttp发起的每个请求和响应：

这种自省机制是确保服务器返回允许资源缓存的HTTP头是非常有用的，以及验证没有请求时，保证缓存的资源存在。

要想使用Stetho，只需添加一个StethoInterceptor实例的网络拦截器列表：

okHttpClient.networkInterceptors().add(new StethoInterceptor());

okHttpClient.networkInterceptors().add(new StethoInterceptor());

然后，运行应用程序，打开浏览器后，输入chrome://inspect。然后你就会看到应用程序的设备和标识符的列表。然后鼠标右键选择inspect 打开开发者工具，然后打开新的tab，开始监控OkHttp请求。

3. 使用Picasso 和 Retrofit

你可能使用过 Picasso 来加载网络图片，或者使用 Retrofit 来简化发出请求和解码响应。这些第三方库将隐式地创建自己的OkHttpClient供内部使用，如果你不明确指定一个。

Picasso version 2.5.2的OkHttpDownloader类：

private static OkHttpClient defaultOkHttpClient() {
OkHttpClient client = new OkHttpClient();
client.setConnectTimeout(Utils.DEFAULT_CONNECT_TIMEOUT_MILLIS, TimeUnit.MILLISECONDS);
client.setReadTimeout(Utils.DEFAULT_READ_TIMEOUT_MILLIS, TimeUnit.MILLISECONDS);
client.setWriteTimeout(Utils.DEFAULT_WRITE_TIMEOUT_MILLIS, TimeUnit.MILLISECONDS);
return client;
}

private static OkHttpClientdefaultOkHttpClient() {
OkHttpClientclient = new OkHttpClient();
client.setConnectTimeout(Utils.DEFAULT_CONNECT_TIMEOUT_MILLIS, TimeUnit.MILLISECONDS);
client.setReadTimeout(Utils.DEFAULT_READ_TIMEOUT_MILLIS, TimeUnit.MILLISECONDS);
client.setWriteTimeout(Utils.DEFAULT_WRITE_TIMEOUT_MILLIS, TimeUnit.MILLISECONDS);
return client;
}

Retrofit也有类似的工厂方法来创建自己的OkHttpClient。

图片一般在应用程序中需要加载的比较大的资源。尽管Picasso自己维护它的LRU机制来缓存图片，在内存中严格执行。如果客户端尝试使用Picasso来加载图片。Picasso会找不到其在内存中缓存图像，然后将委托加载该图片到它的内部OkHttpClient实例。并且默认情况下该实例将始终从服务器加载图片资源。

作为defaultOkHttpClient的方法不能与上面提到的文件系统中的响应缓存配置结合起来。

指定你自己的OkHttpClient实例允许返回数据从文件系统缓存响应，图片不会从服务器加载。这是非常重要的在程序第一次启动以后。这个时候Picasso的内存缓存是冷的。所以它会频繁的委托OkHttpClient实例去加载图片。

这就需要构建配置了您Picasso 的OkHttpClient实例，如果你在你的代码中使用

Picasso.with(context).load(...)

Picasso.with(context).load(...)

加载图片，你是用的是Picasso的单例模式。这是通过with方法懒汉模式地实例化并配置自己的OkHttpClient。因此，我们必须使我们自己的Picasso实例在单例之前通过wiht方法调用。

实现这个，可以简单的将OkHttpClient实例封装在OkHttpDownloader中，然后传递给 Picasso.Builder 实例的downloader方法。

final Picasso picasso = new Picasso.Builder(context)
.downloader(new OkHttpDownloader(okHttpClient))
.build();

// The client should inject this instance whenever it is needed, but replace the singleton
// instance just in case.
Picasso.setSingletonInstance(picasso);

final Picassopicasso = new Picasso.Builder(context)
.downloader(new OkHttpDownloader(okHttpClient))
.build();

// The client should inject this instance whenever it is needed, but replace the singleton
// instance just in case.
Picasso.setSingletonInstance(picasso);

在Retrofit中要使用OkHttpClient实例，需要改造1.9.x的一个RestAdapter，需要将OkHttpClient封装OkClient的实例中。然后把它传递给RestAdapter.Builder实例的setClient方法。

restAdapterBuilder.setClient(new OkClient(httpClient));

restAdapterBuilder.setClient(new OkClient(httpClient));

在 Retrofit 2.0中只需要简单的将OkHttpClient传递给Retrofit.Builder实例的client方法。

在可汗学院的APP中我们通过 Dagger 依赖注入来确保我们只有一个OkHttpClient的实例。这种方法同样也适用于Picasso和Retrofit我们提供了一个为OkHttpClient实例提供单例模式的注解示例：

@Provides
@Singleton
public OkHttpClient okHttpClient(final Context context, ...) {
final OkHttpClient okHttpClient = new OkHttpClient();
configureClient(okHttpClient, ...);
return okHttpClient;
}

@Provides
@Singleton
public OkHttpClientokHttpClient(final Contextcontext, ...) {
final OkHttpClientokHttpClient = new OkHttpClient();
configureClient(okHttpClient, ...);
return okHttpClient;
}

OkHttpClient将会通过Dagger的注解创建一个实例提供给我们的Picasso和Retrofit。

4.指定一个用户代理拦截器

日志文件和分析为我们提供了更多有用的信息，当客户在每个请求提供详细的User-Agent
header值的时候。默认情况下，Okhttp包含User-Agent值只有在特定的Okhttp版本中。为了指定我们自己的user
agent。首先创建拦截器的替换值， 我们可以看stackoverflow的建议 。

public final class UserAgentInterceptor implements Interceptor {
private static final String USER_AGENT_HEADER_NAME = "User-Agent";
private final String userAgentHeaderValue;

public UserAgentInterceptor(String userAgentHeaderValue) {
this.userAgentHeaderValue = Preconditions.checkNotNull(userAgentHeaderValue);
}

@Override
public Response intercept(Chain chain) throws IOException {
final Request originalRequest = chain.request();
final Request requestWithUserAgent = originalRequest.newBuilder()
.removeHeader(USER_AGENT_HEADER_NAME)
.addHeader(USER_AGENT_HEADER_NAME, userAgentHeaderValue)
.build();
return chain.proceed(requestWithUserAgent);
}
}

public final class UserAgentInterceptor implements Interceptor {
private static final String USER_AGENT_HEADER_NAME = "User-Agent";
private final String userAgentHeaderValue;

public UserAgentInterceptor(String userAgentHeaderValue) {
this.userAgentHeaderValue = Preconditions.checkNotNull(userAgentHeaderValue);
}

@Override
public Responseintercept(Chainchain) throws IOException {
final RequestoriginalRequest = chain.request();
final RequestrequestWithUserAgent = originalRequest.newBuilder()
.removeHeader(USER_AGENT_HEADER_NAME)
.addHeader(USER_AGENT_HEADER_NAME, userAgentHeaderValue)
.build();
return chain.proceed(requestWithUserAgent);
}
}

为了创建User-Agent header值人然后传递给UserAgentInterceptor的构造器，使用你得到的任何信息。

我们可以使用：

android 的系统信息可以清晰的传递出这是一台android 设备
Build.MODEL 或者“制造商提供的用户可见最终可见的名称”
Build.BRAND或者“消费者可见的品牌与产品/硬件相关信息”
Build.VERSION.SDK_INT或者“消费者可见的Android提供的SDK版本号”
BuildConfig.APPLICATION_ID
BuildConfig.VERSION_NAME
BuildConfig.VERSION_CODE

最后三个值由的applicationID，VERSIONCODE和VERSIONNAME的值在我们的Gradle build脚本中

了解更多信息可以查看 versioning your applications 和 configuring your applicationId with Gradle

请注意，如果您的应用程序使用的是WebView，您可以配置使用相同的 User-Agent header值，你可以通过下面方法创建UserAgentInterceptor：

WebSettings settings = webView.getSettings();
settings.setUserAgentString(userAgentHeaderValue);

WebSettingssettings = webView.getSettings();
settings.setUserAgentString(userAgentHeaderValue);

5.指定合理的超时

2.5.0版本之前，OkHttp请求默认为永不超时。2.5.0版本开始如果建立连接请求超时，如果从连接读取下一个字节或写入的下一个字节到连接，花费超过10秒，就终止。这样做需要更新到2.5.0版本我们就不需要在我们的代码中修改bug。原因很简单是我因为我们第一次使用的时候使用了错误的路径。

要覆盖这些默认值，可以分别调用setConnectTimeout，setReadTimeout或setWriteTimeout。

需要注意的是Picasso和Retrofit为OkHttpClient实例指定不同的超时值时，默认情况下，Picasso指定：

连接超过15秒.
读取超过20秒
写入超过20秒

而Retrofit指定：

连接超过15秒.
读取超过20秒
没有写入超时

通过配置Picasso和Retrofit自己的OkHttpClient实例你可以确保所有的请求超时是一致的