改造 2 似乎未检查 OkHttp3 缓存答案

【问题标题】：OkHttp3 cache seems to be unchecked with Retrofit 2改造 2 似乎未检查 OkHttp3 缓存
【发布时间】：2016-12-20 15:06:39
【问题描述】：

我正在尝试使用 Retrofit (2.1.0) 和 OkHttp (3.3.1) 设置 HTTP 缓存。我看过很多与这个主题相关的帖子，但都没有帮助。

我写了一些单元测试来看看缓存是如何工作的。它工作得很好，但是一旦集成到我的应用程序中，魔法就结束了。我将首先向您展示我的实现，然后解释我的一些调查。

首先，这是我的改造实例：

    OkHttpClient.Builder httpBuilder = new OkHttpClient.Builder();
    HttpLoggingInterceptor loggingInterceptor = new HttpLoggingInterceptor();
    interceptor.setLevel(HttpLoggingInterceptor.Level.HEADERS);

    OkHttpClient client = httpBuilder
            .addNetworkInterceptor(INTERCEPTOR_RESPONSE_SET_CACHE)
            .addNetworkInterceptor(INTERCEPTOR_REQUEST_ADD_CHECKSUM)
            .addInterceptor(loggingInterceptor)
            .cache(cacheHttpClient).build();

    Retrofit retrofit = new Retrofit.Builder()
            .addConverterFactory(GsonConverterFactory.create())
            .client(client)
            .baseUrl(BASE_URL)
            .build();

这里是拦截器添加一个标头来设置缓存控制：

    private final Interceptor INTERCEPTOR_RESPONSE_SET_CACHE = new Interceptor() {

        @Override
        public Response intercept(Chain chain) throws IOException {
            Response response = chain.proceed(chain.request());
            response = response.newBuilder()
                    .header("Cache-Control", "max-age=600") //+ Integer.toString(3600 * 5)
                    .build();
            return response;
        }
    };

最后一个拦截器添加2个URL参数：

 private static final Interceptor INTERCEPTOR_REQUEST_ADD_CHECKSUM = new Interceptor() {
        @Override
        public Response intercept(Interceptor.Chain chain) throws IOException {
            HttpUrl url = chain.request().url();
            url = url.newBuilder().addQueryParameter("rd", "random1").addQueryParameter("chk","check1").build();
            Request request = chain.request().newBuilder().url(url).build();
            return chain.proceed(request);
        }
    };

最后，我的服务的单一方法：

 @Headers("Cache-Control: public, max-stale=500")
 @GET("/get_data")
 Call<DataResponse> getData(@Query("year") int year, @Query("month") int month, @Query("day") int day);

关于我的调查，我设置了一个拦截器记录器（应用端，而不是网络）来查看发生了什么。我可以在我的日志中看到诸如“Cache-Control: public, max-stale=500”之类的行。这意味着（至少对我而言）标头应该让 OkHttp 客户端有机会检查缓存。

缓存本身似乎已正确初始化。当我创建它时，我强制初始化并记录缓存中存在的所有 url。以下是它的实现方式：

File httpCacheDirectory = new File(getCacheDir(), "responses");
        httpCacheDirectory.getParentFile().mkdirs();
        int cacheSize = 10 * 1024 * 1024; // 10 MiB
        Cache cache = new Cache(httpCacheDirectory, cacheSize);
        try {
            cache.initialize();
            Iterator<String> iterator = cache.urls();
            Log.i(TAG, "URLs in cacheHttpClient : ");
            while (iterator.hasNext()) {
                Log.i(TAG, iterator.next());
            }
        } catch (IOException e) {
            e.printStackTrace();
            Log.i(TAG, "CACHE NOT INIT");
        }

当我在 Wifi 可用的情况下启动我的应用时，我得到了预期的响应。然后我杀死我的应用程序，禁用 Wifi 并重新启动应用程序。我希望缓存此时可以提供数据。但它失败了，我只能在日志中看到 OkHttp 打印行：

HTTP 失败：java.net.UnknownHostException：无法解析主机 “my-domain.com”：没有与主机名关联的地址

最后一件事，RFC 2616，可以阅读：

max-stale ：表示客户端愿意接受响应已超过其到期时间。如果 max-stale 被分配一个值，则客户端愿意接受具有超过其到期时间不超过指定数量秒。如果没有为 max-stale 赋值，那么客户端是愿意接受任何年龄的陈旧回应。

当我没有指定一个值时，它确实有效（即使 Wifi 关闭，我也会收到响应）。目前，这是我发现使其“工作”的唯一方法。所以也许我只是误解了缓存控制指令！？

在这一点上，我真的很困惑。我真的很想能够使用 OkHttp 缓存系统，但不知怎的，我错过了一些东西。

感谢您阅读所有文字！

【问题讨论】：

标签： android caching retrofit2 okhttp3

【解决方案1】：

使用此方法创建缓存的okkhttpclient

private OkHttpClient createCachedClient(final Context context) {
        File httpCacheDirectory = new File(context.getCacheDir(), "cache_file");

        Cache cache = new Cache(httpCacheDirectory, 20 * 1024 * 1024);
        OkHttpClient okHttpClient = new OkHttpClient();
        okHttpClient.setCache(cache);
        okHttpClient.interceptors().add(
                new Interceptor() {
                    @Override
                    public com.squareup.okhttp.Response intercept(Chain chain) throws IOException {
                        Request originalRequest = chain.request();
                        String cacheHeaderValue = isOnline(context)
                                ? "public, max-age=2419200"
                                : "public, only-if-cached, max-stale=2419200" ;
                        Request request = originalRequest.newBuilder().build();
                        com.squareup.okhttp.Response response = chain.proceed(request);
                        return response.newBuilder()
                                .removeHeader("Pragma")
                                .removeHeader("Cache-Control")
                                .header("Cache-Control", cacheHeaderValue)
                                .build();
                    }
                }
        );
        okHttpClient.networkInterceptors().add(
                new Interceptor() {
                    @Override
                    public com.squareup.okhttp.Response intercept(Chain chain) throws IOException {
                        Request originalRequest = chain.request();
                        String cacheHeaderValue = isOnline(context)
                                ? "public, max-age=2419200"
                                : "public, only-if-cached, max-stale=2419200" ;
                        Request request = originalRequest.newBuilder().build();
                        com.squareup.okhttp.Response response = chain.proceed(request);
                        return response.newBuilder()
                                .removeHeader("Pragma")
                                .removeHeader("Cache-Control")
                                .header("Cache-Control", cacheHeaderValue)
                                .build();
                    }
                }
        );
        return okHttpClient;
    }

    private boolean isOnline(Context context) {
        ConnectivityManager connectivity = (ConnectivityManager) _context.getSystemService(Context.CONNECTIVITY_SERVICE);
        if (connectivity != null) {
            NetworkInfo[] info = connectivity.getAllNetworkInfo();
            if (info != null)
                for (int i = 0; i < info.length; i++)
                    if (info[i].getState() == NetworkInfo.State.CONNECTED) {
                        return true;
                    }
        }
        return false;


        }

调用 createCachedClient() 方法创建 OkHttpClient 添加此客户端进行改造

OkHttpClient okHttpClient = createCachedClient(MainActivity.this);
Retrofit retrofit=new Retrofit.Builder()
         .client(okHttpClient)
         .baseUrl(API)
         .addConverterFactory(GsonConverterFactory
         .create()).build();

将此权限添加到清单

<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>

如果互联网第一次可用，它将调用服务并缓存请求，下一次最多 2419200 毫秒，它将使用缓存给出响应。即使设备离线，它也不会在 2419200 毫秒内到达服务器。

【讨论】：

感谢您的回答，但无论当前网络状态如何，我都希望 Retrofit 检查缓存。 Retrofit 应该总是首先检查缓存，并在它仍然有效的情况下返回它的内容。或者干脆尝试获取内容，无论网络状态如何（因为我猜失败时的结果没有被缓存）。
这将做同样的事情。只有第一次它会在每次检查缓存之后访问服务器。
您找到解决方案了吗？我有同样的错误UnknownHostException: Unable to resolve host，但看起来这个错误是由于缓存本身而出现的：我在 UnknownHostException 之前有这个错误remove failed: ENOENT (No such file or directory) : /data/user/0/com.myapp/cache/cache_file/journal.tmp。
@Bogy 当没有 Internet 连接并且 DNS 解析失败时，我通常会得到 UnknownHostException。请确保创建日志文件的目录存在，否则无法创建日志文件。
我已经“手动”创建了文件夹和日志（我认为File httpCacheDirectory = new File(context.getCacheDir(), "cache_file"); Cache cache = new Cache(httpCacheDirectory, 20 * 1024 * 1024); 会自动创建。所以现在我没有remove failed: ENOENTerror 但我仍然遇到UnknownHostException。