web-dev-qa-db-ja.com

OKHttpでRetrofitはオフライン時にキャッシュデータを使用できますか

Retrofit＆OKHttpを使用してHTTP応答をキャッシュしようとしています。 this Gist をたどると、このコードになりました：

File httpCacheDirectory = new File(context.getCacheDir(), "responses");

HttpResponseCache httpResponseCache = null;
try {
     httpResponseCache = new HttpResponseCache(httpCacheDirectory, 10 * 1024 * 1024);
} catch (IOException e) {
     Log.e("Retrofit", "Could not create http cache", e);
}

OkHttpClient okHttpClient = new OkHttpClient();
okHttpClient.setResponseCache(httpResponseCache);

api = new RestAdapter.Builder()
          .setEndpoint(API_URL)
          .setLogLevel(RestAdapter.LogLevel.FULL)
          .setClient(new OkClient(okHttpClient))
          .build()
          .create(MyApi.class);

そして、これはCache-Controlヘッダーを持つMyApiです

public interface MyApi {
   @Headers("Cache-Control: public, max-age=640000, s-maxage=640000 , max-stale=2419200")
   @GET("/api/v1/person/1/")
   void requestPerson(
           Callback<Person> callback
   );

最初にオンラインでリクエストし、キャッシュファイルを確認します。正しいJSON応答とヘッダーがあります。しかし、オフラインで要求しようとすると、常にRetrofitError UnknownHostExceptionが返されます。 Retrofitにキャッシュからの応答を読み取らせるために他にすべきことはありますか？

EDIT：OKHttp 2.0.x HttpResponseCacheはCacheなので、setResponseCacheはsetCacheです

javacachingretrofitokhttpoffline-caching
140
osrl

Retrofit 2.xの編集：

OkHttp Interceptorは、オフライン時にキャッシュにアクセスする正しい方法です。

1）インターセプターの作成：

private static final Interceptor REWRITE_CACHE_CONTROL_INTERCEPTOR = new Interceptor() {
    @Override public Response intercept(Chain chain) throws IOException {
        Response originalResponse = chain.proceed(chain.request());
        if (Utils.isNetworkAvailable(context)) {
            int maxAge = 60; // read from cache for 1 minute
            return originalResponse.newBuilder()
                    .header("Cache-Control", "public, max-age=" + maxAge)
                    .build();
        } else {
            int maxStale = 60 * 60 * 24 * 28; // tolerate 4-weeks stale
            return originalResponse.newBuilder()
                    .header("Cache-Control", "public, only-if-cached, max-stale=" + maxStale)
                    .build();
        }
    }

2）クライアントのセットアップ：

OkHttpClient client = new OkHttpClient();
client.networkInterceptors().add(REWRITE_CACHE_CONTROL_INTERCEPTOR);

//setup cache
File httpCacheDirectory = new File(context.getCacheDir(), "responses");
int cacheSize = 10 * 1024 * 1024; // 10 MiB
Cache cache = new Cache(httpCacheDirectory, cacheSize);

//add cache to the client
client.setCache(cache);

3）クライアントをレトロフィットに追加する

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

@ kosiara-Bartosz Kosarzyckiの answer も確認してください。応答からヘッダーを削除する必要がある場合があります。

OKHttp 2.0.x（元の答えを確認してください）：

OKHttp 2.0.x HttpResponseCacheはCacheであるため、setResponseCacheはsetCacheです。したがって、次のようにsetCacheする必要があります。

        File httpCacheDirectory = new File(context.getCacheDir(), "responses");

        Cache cache = null;
        try {
            cache = new Cache(httpCacheDirectory, 10 * 1024 * 1024);
        } catch (IOException e) {
            Log.e("OKHttp", "Could not create http cache", e);
        }

        OkHttpClient okHttpClient = new OkHttpClient();
        if (cache != null) {
            okHttpClient.setCache(cache);
        }
        String hostURL = context.getString(R.string.Host_url);

        api = new RestAdapter.Builder()
                .setEndpoint(hostURL)
                .setClient(new OkClient(okHttpClient))
                .setRequestInterceptor(/*rest of the answer here */)
                .build()
                .create(MyApi.class);

元の答え：

キャッシュから読み取るためにOkClientを作成するには、サーバー応答にCache-Control: publicが必要であることがわかります。

また、利用可能なときにネットワークからリクエストする場合は、Cache-Control: max-age=0リクエストヘッダーを追加する必要があります。 この回答 は、パラメーター化の方法を示しています。これは私がそれを使用した方法です：

RestAdapter.Builder builder= new RestAdapter.Builder()
   .setRequestInterceptor(new RequestInterceptor() {
        @Override
        public void intercept(RequestFacade request) {
            request.addHeader("Accept", "application/json;versions=1");
            if (MyApplicationUtils.isNetworkAvailable(context)) {
                int maxAge = 60; // read from cache for 1 minute
                request.addHeader("Cache-Control", "public, max-age=" + maxAge);
            } else {
                int maxStale = 60 * 60 * 24 * 28; // tolerate 4-weeks stale
                request.addHeader("Cache-Control", 
                    "public, only-if-cached, max-stale=" + maxStale);
            }
        }
});
177
osrl

上記のすべてのアンサーは、私にとってはうまくいきませんでした。 retrofit 2.0.0-beta2でオフラインキャッシュを実装しようとしました。 okHttpClient.networkInterceptors()メソッドを使用してインターセプターを追加しましたが、キャッシュをオフラインで使用しようとしたときにJava.net.UnknownHostExceptionを受け取りました。 okHttpClient.interceptors()も追加する必要があることがわかりました。

問題は、サーバーがPragma:no-cacheを返したためにキャッシュがフラッシュストレージに書き込まれなかったため、OkHttpが応答を保存できないことでした。要求ヘッダー値を変更した後でも、オフラインキャッシュは機能しませんでした。いくつかの試行錯誤の後、リクエストの代わりに応答からプラグマを削除することで、バックエンド側を変更せずにキャッシュを動作させました-response.newBuilder().removeHeader("Pragma");

改良：2.0.0-beta2; OkHttp：2.5.

OkHttpClient okHttpClient = createCachedClient(context);
Retrofit retrofit = new Retrofit.Builder()
        .client(okHttpClient)
        .baseUrl(API_URL)
        .addConverterFactory(GsonConverterFactory.create())
        .build();
service = retrofit.create(RestDataResource.class);

...

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 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();
                    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 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();
                    Response response = chain.proceed(request);
                    return response.newBuilder()
                        .removeHeader("Pragma")
                        .removeHeader("Cache-Control")
                        .header("Cache-Control", cacheHeaderValue)
                        .build();
                }
            }
    );
    return okHttpClient;
}

...

public interface RestDataResource {

    @GET("rest-data") 
    Call<List<RestItem>> getRestData();

}
28
kosiara - Bartosz Kosarzycki

私の解決策：

private BackendService() {

    httpCacheDirectory = new File(context.getCacheDir(),  "responses");
    int cacheSize = 10 * 1024 * 1024; // 10 MiB
    Cache cache = new Cache(httpCacheDirectory, cacheSize);

    httpClient = new OkHttpClient.Builder()
            .addNetworkInterceptor(REWRITE_RESPONSE_INTERCEPTOR)
            .addInterceptor(OFFLINE_INTERCEPTOR)
            .cache(cache)
            .build();

    Retrofit retrofit = new Retrofit.Builder()
            .baseUrl("https://api.backend.com")
            .client(httpClient)
            .addConverterFactory(GsonConverterFactory.create())
            .build();

    backendApi = retrofit.create(BackendApi.class);
}

private static final Interceptor REWRITE_RESPONSE_INTERCEPTOR = chain -> {
    Response originalResponse = chain.proceed(chain.request());
    String cacheControl = originalResponse.header("Cache-Control");

    if (cacheControl == null || cacheControl.contains("no-store") || cacheControl.contains("no-cache") ||
            cacheControl.contains("must-revalidate") || cacheControl.contains("max-age=0")) {
        return originalResponse.newBuilder()
                .header("Cache-Control", "public, max-age=" + 10)
                .build();
    } else {
        return originalResponse;
    }
};

private static final Interceptor OFFLINE_INTERCEPTOR = chain -> {
    Request request = chain.request();

    if (!isOnline()) {
        Log.d(TAG, "rewriting request");

        int maxStale = 60 * 60 * 24 * 28; // tolerate 4-weeks stale
        request = request.newBuilder()
                .header("Cache-Control", "public, only-if-cached, max-stale=" + maxStale)
                .build();
    }

    return chain.proceed(request);
};

public static boolean isOnline() {
    ConnectivityManager cm = (ConnectivityManager) MyApplication.getApplication().getSystemService(Context.CONNECTIVITY_SERVICE);
    NetworkInfo netInfo = cm.getActiveNetworkInfo();
    return netInfo != null && netInfo.isConnectedOrConnecting();
}
22
Arkadiusz Konior

答えはYESです。上記の答えに基づいて、可能性のあるすべてのユースケースを検証するユニットテストを書き始めました。

  • オフライン時にキャッシュを使用する
  • 有効期限が切れるまで最初にキャッシュされた応答を使用し、次にネットワーク
  • 最初にネットワークを使用してから、一部のリクエストにキャッシュします
  • 一部の応答についてはキャッシュに保存しないでください

OKHttpキャッシュを簡単に設定するための小さなヘルパーライブラリを作成しました。Githubで関連するユニットテストを確認できます： https://github.com/ncornette/OkCacheControl/blob/master/okcache-control/src/test/ Java/com/ncornette/cache/OkCacheControlTest.Java

オフライン時のキャッシュの使用を示すユニットテスト：

@Test
public void test_USE_CACHE_WHEN_OFFLINE() throws Exception {
    //given
    givenResponseInCache("Expired Response in cache", -5, MINUTES);
    given(networkMonitor.isOnline()).willReturn(false);

    //when
    //This response is only used to not block when test fails
    mockWebServer.enqueue(new MockResponse().setResponseCode(404));
    Response response = getResponse();

    //then
    then(response.body().string()).isEqualTo("Expired Response in cache");
    then(cache.hitCount()).isEqualTo(1);
}

ご覧のとおり、キャッシュは期限が切れていても使用できます。それが役立つことを願っています。

5
Nicolas Cornette

@ kosiara-bartosz-kasarzyckiの answer に基づいて、retrofit、okhttp、rxjava、およびguavaを使用して、メモリ->ディスク->ネットワークから適切にロードするサンプルプロジェクトを作成しました。 https://github.com/digitalbuddha/StoreDemo

5
FriendlyMikhail

Retrofit2およびOkHTTP3を使用したキャッシュ：

OkHttpClient client = new OkHttpClient
  .Builder()
  .cache(new Cache(App.sApp.getCacheDir(), 10 * 1024 * 1024)) // 10 MB
  .addInterceptor(new Interceptor() {
    @Override public Response intercept(Chain chain) throws IOException {
      Request request = chain.request();
      if (NetworkUtils.isNetworkAvailable()) {
        request = request.newBuilder().header("Cache-Control", "public, max-age=" + 60).build();
      } else {
        request = request.newBuilder().header("Cache-Control", "public, only-if-cached, max-stale=" + 60 * 60 * 24 * 7).build();
      }
      return chain.proceed(request);
    }
  })
  .build();

NetworkUtils.isNetworkAvailable（）静的メソッド：

public static boolean isNetworkAvailable(Context context) {
        ConnectivityManager cm =
                (ConnectivityManager) context.getSystemService(Context.CONNECTIVITY_SERVICE);
        NetworkInfo activeNetwork = cm.getActiveNetworkInfo();
        return activeNetwork != null &&
                activeNetwork.isConnectedOrConnecting();
    }

次に、レトロフィットビルダーにクライアントを追加します。

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

元のソース： https://newfivefour.com/Android-retrofit2-okhttp3-cache-network-request-offline.html

1
Владимир Широков