HTTP缓存

本页面专注于HTTP缓存。如果您想要去重存储对象和/或当数据更改时通知UI，请查看标准化缓存。

ⓘ 注意

HTTP缓存仅适用于Android和JVM。

设置

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

build.gradle[.kts]

1
dependencies {
2
  implementation("com.apollographql.apollo:apollo-http-cache:4.0.0")
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
  // Try the cache first - if it's a miss, try the network 
3
  .httpFetchPolicy(HttpFetchPolicy.CacheFirst)
4

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

8
  // Try the network first - if there's an error, try the cache 
9
  .httpFetchPolicy(HttpFetchPolicy.NetworkFirst)
10

11
  // Don't use the cache
12
  .httpFetchPolicy(HttpFetchPolicy.NetworkOnly)
13
  
14
  // Finally, execute your query
15
  .execute()

注意mutations 和 subscriptions 不走缓存。

如果 query 存在于缓存中，它将用于返回 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

故障排除