สามารถติดตั้งเพิ่มด้วย OKHttp ใช้ข้อมูลแคชเมื่อออฟไลน์

ฉันพยายามใช้ 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);

และนี่คือ 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.x HttpResponseCacheคือCache, setResponseCacheคือsetCache

แก้ไขสำหรับ Retrofit 2.x:

OkHttp Interceptor เป็นวิธีที่เหมาะสมในการเข้าถึงแคชเมื่อออฟไลน์:

1) สร้าง Interceptor:

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คือ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);

คำตอบเดิม:

ปรากฎว่าการตอบสนองของเซิร์ฟเวอร์จะต้อง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);
            }
        }
});

ผู้ใช้ทั้งหมดข้างต้นไม่ได้ผลสำหรับฉัน ฉันพยายามที่จะใช้แคชแบบออฟไลน์ในretrofit 2.0.0-beta2 ฉันเพิ่มตัวดักโดยใช้okHttpClient.networkInterceptors()วิธีการ แต่ได้รับjava.net.UnknownHostExceptionเมื่อฉันพยายามใช้แคชออฟไลน์ ปรากฎว่าฉันต้องเพิ่มokHttpClient.interceptors()เช่นกัน

ปัญหาคือแคชไม่ได้ถูกเขียนไปยังที่เก็บข้อมูลแฟลชเนื่องจากเซิร์ฟเวอร์ส่งคืนPragma:no-cacheซึ่งป้องกันไม่ให้ OkHttp จัดเก็บการตอบกลับ แคชออฟไลน์ไม่ทำงานแม้ว่าจะแก้ไขค่าส่วนหัวคำขอก็ตาม หลังจากการทดลองและข้อผิดพลาดฉันได้รับแคชให้ทำงานโดยไม่ต้องแก้ไขด้านหลังโดยลบ pragma จาก reponse แทนคำขอ -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();

}

ทางออกของฉัน:

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

คำตอบคือใช่จากคำตอบข้างต้นฉันเริ่มเขียนการทดสอบหน่วยเพื่อตรวจสอบกรณีการใช้ที่เป็นไปได้ทั้งหมด:

• ใช้แคชเมื่อออฟไลน์
• ใช้การตอบกลับที่แคชก่อนจนกว่าเครือข่ายจะหมดอายุ
• ใช้เครือข่ายก่อนจากนั้นแคชสำหรับคำขอบางอย่าง
• อย่าเก็บในแคชสำหรับคำตอบบางอย่าง

ฉันสร้าง lib ตัวช่วยเล็ก ๆ เพื่อกำหนดค่าแคช OKHttp ได้อย่างง่ายดายคุณสามารถดู unittest ที่เกี่ยวข้องได้ที่นี่ใน 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);
}

อย่างที่คุณเห็นแคชสามารถใช้ได้แม้ว่าจะหมดอายุแล้วก็ตาม หวังว่ามันจะช่วย

การสร้างคำตอบของ @ kosiara-bartosz-kasarzycki ฉันสร้างโครงการตัวอย่างที่โหลดจากหน่วยความจำ -> ดิสก์ -> เครือข่ายโดยใช้ retrofit, okhttp, rxjava และฝรั่ง https://github.com/digitalbuddha/StoreDemo

แคชที่มี 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