157

Retrofit & OKHttp を使用して HTTP 応答をキャッシュしようとしています。私はこの要点に従い、最終的にこのコードになりました:

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 がキャッシュから応答を読み取れるようにするために他にすべきことはありますか?

編集: OKHttp 2.0.xHttpResponseCacheCachesetResponseCacheあるため、setCache

4

7 に答える 7

196

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回答も確認してください。応答から一部のヘッダーを削除する必要がある場合があります。


OKHttp 2.0.x (元の回答を確認してください):

OKHttp 2.0.xなので、HttpResponseCacheです。だからあなたはこれを好きになるはずです:CachesetResponseCachesetCachesetCache

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

元の回答:

キャッシュから読み取るCache-Control: publicには、サーバーの応答が必要であることが判明しました。OkClient

また、利用可能なときにネットワークからリクエストする場合は、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);
            }
        }
});
于 2014-05-06T19:56:39.970 に答える
30

上記の答えはすべてうまくいきませんでした。レトロフィット 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.0

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

}
于 2015-12-14T11:34:16.537 に答える
22

私の解決策:

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();
}
于 2016-04-22T13:28:46.653 に答える
7

答えはイエスです。上記の答えに基づいて、考えられるすべてのユースケースを検証するために単体テストを書き始めました。

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

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

オフライン時のキャッシュの使用を示す Unittest:

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

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

于 2016-06-22T14:08:21.767 に答える
6

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

于 2015-12-21T17:04:12.903 に答える
2

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

于 2016-05-29T07:17:22.510 に答える