Retrofit con OKHttp può utilizzare i dati della cache quando è offline


148

Sto cercando di utilizzare Retrofit e OKHttp per memorizzare nella cache le risposte HTTP. Ho seguito questa sintesi e ho finito con questo codice:

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

E questo è MyApi con le intestazioni Cache-Control

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

Prima richiedo online e controllo i file della cache. Ci sono le risposte e le intestazioni JSON corrette. Ma quando provo a richiedere offline, ottengo sempre RetrofitError UnknownHostException. C'è qualcos'altro che dovrei fare per fare in modo che Retrofit legga la risposta dalla cache?

EDIT: poiché OKHttp 2.0.x HttpResponseCacheè Cache, lo setResponseCacheèsetCache


1
Il server che stai chiamando risponde con un'intestazione Cache-Control appropriata?
Hassan Ibraheem,

restituisce questo Cache-Control: s-maxage=1209600, max-age=1209600non so se sia abbastanza.
osrl,

Sembra che la publicparola chiave fosse necessaria per essere nell'intestazione della risposta per farlo funzionare offline. Ma queste intestazioni non consentono a OkClient di utilizzare la rete quando è disponibile. Esiste un modo per impostare la politica / strategia della cache per utilizzare la rete quando disponibile?
osrl,

Non sono sicuro che tu possa farlo nella stessa richiesta. È possibile controllare la classe CacheControl pertinente e le intestazioni Cache-Control . Se non esiste un comportamento del genere, probabilmente sceglierei di effettuare due richieste, una sola cache (solo se memorizzata nella cache), seguita da una rete (max-age = 0).
Hassan Ibraheem,

è stata la prima cosa che mi è venuta in mente. Ho trascorso giorni in quelle classi CacheControl e CacheStrategy . Ma l'idea di due richieste non aveva molto senso. Se max-stale + max-ageviene passato, lo richiede dalla rete. Ma voglio impostare max-stantio a settimana. Questo rende la lettura della risposta dalla cache anche se è disponibile una rete.
osrl,

Risposte:


189

Modifica per Retrofit 2.x:

OkHttp Interceptor è il modo giusto per accedere alla cache quando è offline:

1) Crea intercettore:

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) Setup client:

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) Aggiungi client per il retrofit

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

Controllare anche @kosiara - Bartosz Kosarzycki 's risposta . Potrebbe essere necessario rimuovere alcune intestazioni dalla risposta.


OKHttp 2.0.x (Controlla la risposta originale):

Poiché OKHttp 2.0.x HttpResponseCacheè Cache, setResponseCacheè setCache. Quindi dovresti setCachegradire questo:

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

Risposta originale:

Si scopre che la risposta del server deve essere Cache-Control: publicfatta OkClientleggere dalla cache.

Inoltre, se si desidera richiedere dalla rete quando disponibile, è necessario aggiungere l' Cache-Control: max-age=0intestazione della richiesta. Questa risposta mostra come farlo parametrizzato. Ecco come l'ho usato:

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

(Mi chiedevo perché non funzionasse; alla fine mi sono dimenticato di impostare la cache effettiva da utilizzare per OkHttpClient. Vedi il codice nella domanda o in questa risposta .)
Jonik

2
Solo una parola di consiglio: HttpResponseCache has been renamed to Cache.** Install it with OkHttpClient.setCache(...) instead of OkHttpClient.setResponseCache(...).
Henrique de Sousa,

2
Non ricevo l'interceptor chiamato quando la rete non è disponibile. Non sono sicuro di come colpirà la condizione in cui la rete non è disponibile. Mi sto perdendo qualcosa qui?
Androidme,

2
è if (Utils.isNetworkAvailable(context))corretto o dovrebbe essere invertito, ad esempio if (!Utils.isNetworkAvailable(context))?
ericn,

2
Sto usando Retrofit 2.1.0 e quando il telefono è offline, public okhttp3.Response intercept(Chain chain) throws IOExceptionnon viene mai chiamato, viene chiamato solo quando sono online
ericn

28

Tutte le risposte sopra non hanno funzionato per me. Ho provato a implementare la cache offline in retrofit 2.0.0-beta2 . Ho aggiunto un intercettore usando il okHttpClient.networkInterceptors()metodo ma java.net.UnknownHostExceptionho ricevuto quando ho provato a usare la cache offline. Si è scoperto che ho dovuto aggiungere okHttpClient.interceptors()anche io .

Il problema era che la cache non veniva scritta nella memoria flash perché il server restituiva il Pragma:no-cacheche impedisce a OkHttp di archiviare la risposta. La cache offline non ha funzionato anche dopo aver modificato i valori dell'intestazione della richiesta. Dopo alcuni tentativi ed errori ho fatto funzionare la cache senza modificare il lato backend rimuovendo pragma dalla risposta invece della richiesta -response.newBuilder().removeHeader("Pragma");

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

}

6
Sembra che tu interceptors ()sia networkInterceptors ()identico. Perché hai duplicato questo?
toobsco42,

diversi tipi di intercettori leggi qui. github.com/square/okhttp/wiki/Interceptors
Rohit Bandil

sì, ma entrambi fanno le stesse cose, quindi sono abbastanza sicuro che 1 intercettore dovrebbe essere sufficiente, giusto?
Ovidiu Latcu,

c'è un motivo specifico per non utilizzare la stessa istanza dell'interceptor per entrambi .networkInterceptors().add()e interceptors().add()?
ccpizza,

22

La mia soluzione:

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

3
non funziona per me ... Ottenere 504 richieste insoddisfacenti (solo se memorizzate nella cache)
zacharia

Solo la tua soluzione mi aiuta, grazie mille.
Sprechi

1
sì, l'unica soluzione funzionante nel mio caso. (Retrofit 1.9.x + okHttp3)
Hoang Nguyen Huu,

1
Funziona con Retrofit RETROFIT_VERSION = 2.2.0 OKHTTP_VERSION = 3.6.0
Tadas Valaitis

come aggiungere builder.addheader () in questo metodo per accedere a api con autorizzazione?
Abhilash,

6

La risposta è SÌ, sulla base delle risposte di cui sopra, ho iniziato a scrivere test unitari per verificare tutti i possibili casi d'uso:

  • Usa la cache quando sei offline
  • Utilizzare la risposta memorizzata nella cache prima fino alla scadenza, quindi in rete
  • Utilizzare prima la rete, quindi la cache per alcune richieste
  • Non archiviare nella cache per alcune risposte

Ho creato una piccola libreria di aiuto per configurare facilmente la cache OKHttp, puoi vedere il relativo unittest qui su Github: https://github.com/ncornette/OkCacheControl/blob/master/okcache-control/src/test/java/com/ ncornette / cache / OkCacheControlTest.java

Unittest che dimostra l'uso della cache quando è offline:

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

Come puoi vedere, la cache può essere utilizzata anche se è scaduta. Spero che possa essere d'aiuto.


2
La tua lib è fantastica! Grazie per il tuo duro lavoro. The lib: github.com/ncornette/OkCacheControl
Hoang Nguyen Huu


2

Cache con Retrofit2 e 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();

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

Quindi aggiungi il client al costruttore di retrofit:

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

Fonte originale: https://newfivefour.com/android-retrofit2-okhttp3-cache-network-request-offline.html


1
quando carico per la prima volta con la modalità offline, si blocca! altrimenti funziona correttamente
Zafer Celaloglu,

questo non funziona per me. L'ho copiato e incollato e l'ho provato dopo aver provato a integrarne il principio, ma non riesco a farlo funzionare.
Ragazzo

App.sApp.getCacheDir () che cosa fa questo?
Huzaifa Asif
Utilizzando il nostro sito, riconosci di aver letto e compreso le nostre Informativa sui cookie e Informativa sulla privacy.
Licensed under cc by-sa 3.0 with attribution required.