OKHttp ile Retrofit, çevrimdışıyken önbellek verilerini kullanabilir

Question 1

HTTP yanıtlarını önbelleğe almak için Retrofit & OKHttp'yi kullanmaya çalışıyorum. Bu özü takip ettim ve şu kodu aldım :

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

Ve bu, Cache-Control başlıklarına sahip 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
   );

Önce çevrimiçi talep ediyorum ve önbellek dosyalarını kontrol ediyorum. Doğru JSON yanıtı ve üstbilgiler var. Ancak çevrimdışı talep etmeye çalıştığımda her zaman alıyorum RetrofitError UnknownHostException. Retrofit'in önbellekten gelen yanıtı okumasını sağlamak için yapmam gereken başka bir şey var mı?

DÜZENLEME: OKHttp 2.0.x yana HttpResponseCacheolduğunu Cache, setResponseCacheolupsetCache

Question 2

Retrofit 2.x için düzenleme:

OkHttp Interceptor, çevrimdışıyken önbelleğe erişmenin doğru yoludur:

1) Interceptor Oluşturun:

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) Kurulum istemcisi:

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) Güçlendirmeye müşteri ekleyin

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

Ayrıca kontrol @kosiara - Bartosz Kosarzycki 'ın cevabı . Yanıttan bazı başlıkları kaldırmanız gerekebilir.

OKHttp 2.0.x (Orijinal yanıtı kontrol edin):

OKHttp 2.0.x yana HttpResponseCacheolduğunu Cache, setResponseCacheolduğunu setCache. Yani şunu beğenmelisiniz 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);

Orijinal Cevap:

Sunucu yanıtının önbellekten okumak Cache-Control: publiciçin yapması gerektiği ortaya çıktı OkClient.

Ayrıca mevcut olduğunda şebekeden talepte bulunmak istiyorsanız, Cache-Control: max-age=0istek başlığı eklemelisiniz . Bu cevap , parametreleştirmenin nasıl yapılacağını gösterir. Ben böyle kullandım:

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

Question 3

Yukarıdaki cevapların hiçbiri benim için işe yaramadı. Güçlendirme 2.0.0-beta2'de çevrimdışı önbelleği uygulamaya çalıştım . okHttpClient.networkInterceptors()Yöntemi kullanarak bir engelleyici ekledim ancak java.net.UnknownHostExceptionönbelleği çevrimdışı kullanmaya çalıştığımda aldım. Benim de eklemem gerektiği ortaya çıktı okHttpClient.interceptors().

Sorun, önbelleğin flash belleğe yazılmamasıydı, çünkü sunucu geri döndü ve Pragma:no-cachebu da OkHttp'nin yanıtı depolamasını engelliyordu. Çevrimdışı önbellek, istek başlığı değerleri değiştirildikten sonra bile çalışmadı. Biraz deneme yanılma işleminden sonra, istek yerine yanıttan pragmayı kaldırarak arka uç tarafını değiştirmeden önbelleğin çalışmasını sağladım -response.newBuilder().removeHeader("Pragma");

Güçlendirme: 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();

}

Question 4

Çözümüm:

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

Question 5

Cevap EVET, yukarıdaki cevaplara dayanarak, tüm olası kullanım durumlarını doğrulamak için birim testleri yazmaya başladım:

Çevrimdışıyken önbelleği kullan
Önce süresi dolana kadar önbelleğe alınmış yanıtı, ardından ağı kullanın
Önce ağı kullan, sonra bazı istekler için önbelleğe al
Bazı yanıtlar için önbellekte saklamayın

OKHttp önbelleğini kolayca yapılandırmak için küçük bir yardımcı kitap oluşturdum, ilgili birim testini burada Github'da görebilirsiniz: https://github.com/ncornette/OkCacheControl/blob/master/okcache-control/src/test/java/com/ ncornette / önbellek / OkCacheControlTest.java

Çevrimdışıyken önbellek kullanımını gösteren 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);
}

Gördüğünüz gibi, önbellek süresi dolmuş olsa bile kullanılabilir. Umarım yardımcı olur.

Question 6

@ kosiara-bartosz-kasarzycki'nin cevabına dayanarak, retrofit, okhttp, rxjava ve guava kullanarak bellek-> disk-> ağından düzgün bir şekilde yüklenen örnek bir proje oluşturdum. https://github.com/digitalbuddha/StoreDemo

Question 7

Retrofit2 ve OkHTTP3 ile önbellek:

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 () statik yöntemi:

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

Ardından, iyileştirme oluşturucuya müşteri ekleyin:

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

Orijinal kaynak: https://newfivefour.com/android-retrofit2-okhttp3-cache-network-request-offline.html