HTTP缓存

本页重点介绍HTTP缓存。如果您想去重存储对象和/或通知界面数据发生变化，请参阅标准化缓存。

ℹ️ HTTP缓存仅在JVM上可用。

设置

要启用HTTP缓存支持，将依赖项添加到项目的build.gradle文件中：

build.gradle[.kts]

1
dependencies {
2
  implementation("com.apollographql.apollo3:apollo-http-cache:3.8.5")
3
}

如果您针对的目标Android API级别 < 26，则需要启用核心库集解以支持java.time API：

1
android {
2
    compileOptions {
3
        // Flag to enable support for the new language APIs
4
        coreLibraryDesugaringEnabled = true
5
    }
6
}

然后配置您的HTTP缓存

1
apolloClient = ApolloClient.Builder()
2
    .httpCache(
3
      // Use a dedicated directory for the cache
4
      directory = File(pathToCacheDirectory),
5
      // Configure a max size of 100MB
6
      maxSize = 100 * 1024 * 1024
7
    )
8
    .build()

用法

HTTP缓存是一个具有可配置最大大小的最不常使用（LRU）缓存。

一旦完成缓存设置，所有查询将默认使用缓存。默认情况下，查询将首先在缓存中尝试找到结果，如果没有，则访问网络。这是HttpFetchPolicy.CacheFirst。您可以使用httpFetchPolicy(HttpFetchPolicy)自定义此行为：

1
val response = apolloClient.query(query)
2
                 // Don't use the cache
3
                 .httpFetchPolicy(HttpFetchPolicy.NetworkOnly)
4

5
                 // Or only use the cache
6
                 .httpFetchPolicy(HttpFetchPolicy.CacheOnly)
7

8
                 // Finally, execute your query
9
                 .execute()

如果查询已缓存，将使用缓存的response.data返回。如果没有，则会抛出HttpCacheMissException异常。

您还可以设置全局或特定查询的过期时间。一旦超过过期时间，条目将自动从缓存中删除

1
// Globally
2
apolloClient = ApolloClient.Builder()
3
    .httpCache(/*...*/)
4
    // Expire after 1 hour
5
    .httpExpireTimeout(60 * 60 * 1000)
6
    .build()
7

8
// On a specific query
9
val response = apolloClient.query(query)
10
    // Expire after 1 hour
11
    .httpExpireTimeout(60 * 60 * 1000)
12
    .execute()

如果特定查询不能缓存，您可以使用httpDoNotStore()：

1
val response = apolloClient.query(query)
2
    // Don't cache this query
3
    .httpDoNotStore(httpDoNotStore = true)
4
    .execute()

清除缓存

调用apolloClient.httpCache.clearAll() 来清除所有条目的缓存。

ApolloStore

故障排除