10.2. 配置缓存

使用本地缓存将以下数据保存在集群中的每个节点中：

域、用户和授权的本地缓存配置为默认容纳最多 10,000 个条目。本地密钥缓存每默认值最多可容纳 1,000 个条目，默认为每小时过期。因此，密钥会被强制从外部客户端或身份提供程序定期下载。

为了实现最佳运行时并避免对数据库的额外往返，您应该考虑查看每个缓存的配置，以确保最大条目数与数据库的大小一致。您可以缓存更多条目，通常服务器需要从数据库获取数据。您应该评估内存利用率和性能之间的利弊。

当一个红帽构建的 Keycloak 节点更新共享数据库中数据时，所有其他节点都需要了解它，因此它们会导致数据从其缓存中无效。

工作 缓存是一种复制缓存，用于发送这些失效消息。这个缓存中的条目/消息非常短，您不应该预期这个缓存的大小会随时间增长。

authenticationSessions 分布式缓存用于存储身份验证会话，以及在身份验证过程中与其关联的任何其他数据。

通过依赖可分布式缓存，身份验证会话可供集群中的任何节点使用，以便用户可以重定向到任何节点，而不会丢失其身份验证状态。但是，生产环境就绪的部署应始终考虑会话关联，而是将用户重定向到初始创建会话的节点。通过这样做，您要避免节点间不必要的状态传输，并改进 CPU、内存和网络利用率。

当用户执行注销时，用户和客户端会话都会自动销毁，客户端会执行令牌撤销，或者因为达到它们的过期时间而被销毁。

会话数据默认存储在数据库中，并按需载入到以下缓存：

通过依赖可分布式缓存，缓存的用户和客户端会话可供集群中的任何节点使用，以便用户可以重定向到任何节点，而无需从数据库加载会话数据。但是，生产环境就绪的部署应始终考虑会话关联，而是将用户重定向到初始创建会话的节点。通过这样做，您要避免节点间不必要的状态传输，并改进 CPU、内存和网络利用率。

对于用户会话和客户端会话的内存缓存，默认为每个节点，10000 个条目会减少红帽构建的 Keycloak 的总内存用量。内部缓存将只为每个缓存条目使用一个所有者运行。

以下缓存用于存储离线会话：

与用户和客户端会话缓存一样，离线用户和客户端会话缓存默认限制为每个节点 10000 条目。根据需要，从内存驱除的项目将从数据库根据需要加载。

默认情况下，常规用户会话存储在数据库中，并按需加载到缓存中。可以配置红帽构建的 Keycloak，以仅将常规用户会话存储在缓存中，并最小化对数据库的调用。

由于此设置中的所有会话都存储在内存中，因此与此相关的两个副作用：

在使用易失性用户会话时，缓存是用户和客户端会话的真实来源。Red Hat build of Keycloak 会自动调整可在内存中存储的条目数量，并增加副本数以防止数据丢失。

按照以下步骤启用此设置：

为了减少内存用量，可以将上限放在存储在给定缓存中的条目数。要在缓存上指定 的上限，您必须提供以下命令行参数 --cache-embedded-${CACHE_NAME}-max-count=，用 ${CACHE_NAME} 替换要应用上限的缓存名称。例如，要将上限 1000 应用到 offlineSessions 缓存，您需要 configure --cache-embedded-offline-sessions-max-count=1000。在以下缓存上不能定义上限： actionToken,authenticationSessions,loginFailures,work。

在启用易失性会话时，不支持为 会话、clientSessions、offlineSessions 和 offlineClientSessions 设置最大缓存大小。

要指定您自己的缓存配置文件，请输入以下命令：

bin/kc.[sh|bat] start --cache-config-file=my-cache-file.xml

bin/kc.[sh|bat] start --cache-config-file=my-cache-file.xml

配置文件相对于 conf/ 目录。

为了配置红帽构建的 Keycloak 服务器配置，以实现高可用性和多节点集群设置，包括以下 CLI 选项 cache-remote-host、cache-remote-port、cache-remote-username 和 cache-remote-password 简化 XML 文件中的配置。存在任何声明的 CLI 参数后，XML 文件中应当没有与远程存储相关的配置。