© 2010-2022 原作者。

您可以复制此文档供自己使用,也可以分发给其他人,但前提是您不收取任何费用,并且每个副本(无论是印刷版还是电子版)都包含此版权声明。

前言

Spring Data for Apache Geode 侧重于将 Spring Framework 的强大、非侵入式编程模型和概念与 Apache Geode 集成,以简化使用 Apache Geode 作为数据管理解决方案时 Java 应用程序的配置和开发。

本文档假设您已经对 Spring Framework 和 Apache Geode 的核心概念有一定的了解和熟悉。

尽管我们尽一切努力确保本文档全面完整且无误,但有些主题超出了本文档的范围,可能需要更多解释(例如,使用 HA 进行分区的数据分布管理,同时保持一致性)。此外,可能还存在一些排版错误。如果您发现错误,甚至更严重的错误,请通过在 JIRA 中创建相应的 问题,将这些问题告知 Spring Data 团队。

1. 简介

Spring Data for Apache Geode 参考指南解释了如何使用 Spring Framework 配置和开发使用 Apache Geode 的应用程序。它介绍了基本概念,并提供了大量示例来帮助您快速入门。

2. 需求

Spring Data for Apache Geode 需要 Java 8.0、Spring Framework 5 和 Apache Geode 1.9.0。

3. 新功能

从 1.2.0.RELEASE 版本开始,这个项目以前称为 Spring GemFire,现在更名为 Spring Data for Apache Geode,以反映它现在是 Spring Data 项目的模块,并且构建在 Apache Geode 之上。

3.1. 2.0 版本新增功能

  • 升级到 Apache Geode 9.1.1。

  • 升级到 Spring Data Commons 2.0.8.RELEASE。

  • 升级到 Spring Framework 5.0.7.RELEASE。

  • 通过按关注点对不同的类和组件进行打包,重新组织了 SDG 代码库。

  • 为 Java 8 类型添加了广泛的支持,特别是在 SD 存储库抽象中。

  • 更改为存储库接口和抽象,例如 ID 不再需要是 java.io.Serializable

  • 默认情况下,将 @EnableEntityDefinedRegions 注释的 ignoreIfExists 属性设置为 true

  • 默认情况下,将 @Indexed 注释的 override 属性设置为 false

  • @EnableIndexes 重命名为 @EnableIndexing

  • 引入了 InterestsBuilder 类,以便在使用 JavaConfig 时轻松便捷地表达客户端和服务器之间键和值的兴趣。

  • 在注释配置模型中添加了对 Off-Heap、Redis 适配器和 Apache Geode 新安全框架的支持。

3.2. 2.1 版本新增功能

  • 升级到 Apache Geode 1.9.0。

  • 升级到 Spring Framework 5.1.0.RELEASE。

  • 升级到 Spring Data Commons 2.1.0.RELEASE。

  • 添加了对并行缓存/区域快照的支持,以及在加载快照时调用回调。

  • 添加了对注册 QueryPostProcessors 的支持,以自定义为存储库查询方法生成的 OQL。

  • 在 o.s.d.g.mapping.MappingPdxSerializer 中添加了对包含/排除类型过滤器的支持。

  • 更新了文档。

3.3. 2.2 版本新增功能

  • 升级到 Apache Geode 1.9.0。

  • 升级到 Spring Framework 5.2.0.RELEASE。

  • 升级到 Spring Data Commons 2.2.0.RELEASE。

  • 添加了注释配置支持,以使用 @LocatorApplication 配置和引导 Apache Geode 定位器应用程序。

  • 添加了对网关接收器和网关发送器的注释配置支持。

  • 更新了文档。

参考指南

4. 文档结构

以下章节解释了 Spring Data for Apache Geode 提供的核心功能

  • 使用 Spring 容器引导 Apache Geode 描述了为配置、初始化和访问 Apache Geode 缓存、区域和相关分布式系统组件提供的配置支持。

  • 使用 Apache Geode API 解释了 Apache Geode API 与 Spring 中提供的各种数据访问功能(如基于模板的数据访问、异常转换、事务管理和缓存)之间的集成。

  • 使用 Apache Geode 序列化 描述了对 Apache Geode 管理对象的序列化和反序列化的增强。

  • POJO 映射 描述了使用 Spring Data 将存储在 Apache Geode 中的 POJO 进行持久化映射。

  • Spring Data for Apache Geode 存储库 描述了如何使用 Spring Data 存储库来访问存储在 Apache Geode 中的数据,方法是使用基本的 CRUD 和简单的查询操作。

  • 函数执行的注解支持 描述了如何使用注解创建和使用 Apache Geode 函数来执行分布式计算,这些计算在数据所在的位置进行。

  • 连续查询 (CQ) 描述了如何使用 Apache Geode 的连续查询 (CQ) 功能来处理基于兴趣的事件流,该兴趣是在 Apache Geode 的 OQL(对象查询语言)中定义和注册的。

  • 在 Apache Geode 中引导 Spring ApplicationContext 描述了如何使用 Gfsh 配置和引导在 Apache Geode 服务器中运行的 Spring ApplicationContext

  • 示例应用程序 描述了与分发一起提供的示例,以说明 Spring Data for Apache Geode 中提供的各种功能。

5. 使用 Spring 容器引导 Apache Geode

Spring Data for Apache Geode 使用 Spring IoC 容器提供 Apache Geode 内存数据网格 (IMDG) 的完整配置和初始化。该框架包含几个类来帮助简化 Apache Geode 组件的配置,包括:缓存、区域、索引、磁盘存储、函数、WAN 网关、持久性备份以及其他几个分布式系统组件,以支持各种应用程序用例,而无需付出太多努力。

本节假设您对 Apache Geode 有基本了解。有关更多信息,请参阅 Apache Geode 产品文档

5.1. 使用 Spring 比 Apache Geode cache.xml 的优势

Spring Data for Apache Geode 的 XML 命名空间支持 Apache Geode 内存数据网格 (IMDG) 的完整配置。XML 命名空间是两种在 Spring 上下文中配置 Apache Geode 的方法之一,以便在 Spring 容器中正确管理 Apache Geode 的生命周期。在 Spring 上下文中配置 Apache Geode 的另一种方法是使用 基于注解的配置

虽然出于遗留原因,对 Apache Geode 的原生 cache.xml 的支持仍然存在,但使用 XML 配置的 Apache Geode 应用程序开发人员建议在 Spring XML 中完成所有操作,以利用 Spring 提供的许多出色功能,例如模块化 XML 配置、属性占位符和覆盖、SpEL (Spring 表达式语言) 和环境配置文件。在 XML 命名空间的背后,Spring Data for Apache Geode 广泛使用 Spring 的 FactoryBean 模式来简化 Apache Geode 组件的创建、配置和初始化。

Apache Geode 提供了几个回调接口,例如 CacheListenerCacheLoaderCacheWriter,这些接口允许开发人员添加自定义事件处理程序。使用 Spring 的 IoC 容器,您可以将这些回调配置为普通的 Spring bean,并将它们注入到 Apache Geode 组件中。这是对原生 cache.xml 的重大改进,原生 cache.xml 提供的配置选项相对有限,并且要求回调实现 Apache Geode 的 Declarable 接口(请参阅 连接 Declarable 组件,了解如何在 Spring 的容器中使用 Declarables)。

此外,IDE(如 Spring Tool Suite (STS))为 Spring XML 命名空间提供了出色的支持,包括代码补全、弹出式注释和实时验证。

5.2. 使用核心命名空间

为了简化配置,Spring Data for Apache Geode 提供了一个专门的 XML 命名空间来配置核心 Apache Geode 组件。可以使用 Spring 的标准 <bean> 定义直接配置 bean。但是,所有 bean 属性都通过 XML 命名空间公开,因此使用原始 bean 定义几乎没有好处。

有关 Spring 中基于 XML 架构的配置的更多信息,请参阅 Spring 框架参考文档中的附录
Spring Data Repository 支持使用单独的 XML 命名空间。有关如何配置 Spring Data for Apache Geode Repositories 的更多信息,请参阅Spring Data for Apache Geode Repositories

要使用 Spring Data for Apache Geode XML 命名空间,请在您的 Spring XML 配置元数据中声明它,如下面的示例所示

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:gfe="https://www.springframework.org/schema/geode" (1)(2)
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="
    http://www.springframework.org/schema/beans https://www.springframework.org/schema/beans/spring-beans.xsd
    https://www.springframework.org/schema/geode https://www.springframework.org/schema/geode/spring-geode.xsd (3)
">

  <bean id ... >

  <gfe:cache ...> (4)

</beans>
1 Spring Data for Apache Geode XML 命名空间前缀。任何名称都可以,但在整个参考文档中,使用 gfe
2 XML 命名空间前缀映射到 URI。
3 XML 命名空间 URI 位置。请注意,即使位置指向外部地址(确实存在且有效),Spring 也会在本地解析模式,因为它包含在 Spring Data for Apache Geode 库中。
4 使用带有 gfe 前缀的 XML 命名空间的示例声明。

您可以将默认命名空间从 beans 更改为 gfe。这对于主要由 Apache Geode 组件组成的 XML 配置很有用,因为它避免了声明前缀。为此,请交换前面显示的命名空间前缀声明,如下面的示例所示

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="https://www.springframework.org/schema/geode" (1)
       xmlns:beans="http://www.springframework.org/schema/beans" (2)
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="
    http://www.springframework.org/schema/beans https://www.springframework.org/schema/beans/spring-beans.xsd
    https://www.springframework.org/schema/geode https://www.springframework.org/schema/geode/spring-geode.xsd
">

  <beans:bean id ... > (3)

  <cache ...> (4)

</beans>
1 此 XML 文档的默认命名空间声明指向 Spring Data for Apache Geode XML 命名空间。
2 Spring 的原始 bean 定义的 beans 命名空间前缀声明。
3 使用 beans 命名空间的 bean 声明。请注意前缀。
4 使用 gfe 命名空间的 bean 声明。请注意,由于 gfe 是默认命名空间,因此没有前缀。

5.3. 使用数据访问命名空间

除了核心 XML 命名空间 (gfe) 之外,Spring Data for Apache Geode 还提供了一个数据访问 XML 命名空间 (gfe-data),它主要用于简化 Apache Geode 客户端应用程序的开发。此命名空间目前包含对 Apache Geode Repositories 和 Function execution 的支持,以及一个 <datasource> 标签,它提供了一种方便的方式来连接到 Apache Geode 集群。

5.3.1. 连接 Apache Geode 的简便方法

对于许多应用程序来说,使用默认值连接到 Apache Geode 数据网格就足够了。Spring Data for Apache Geode 的 <datasource> 标签提供了一种简单的方式来访问数据。数据源创建了一个 ClientCache 和连接 Pool。此外,它查询集群服务器以获取所有现有的根 Region,并为每个根 Region 创建一个(空的)客户端 Region 代理。

<gfe-data:datasource>
  <locator host="remotehost" port="1234"/>
</gfe-data:datasource>

<datasource> 标签在语法上类似于 <gfe:pool>。它可以使用一个或多个嵌套的 locatorserver 元素进行配置,以连接到现有的数据网格。此外,还支持所有可用于配置 Pool 的属性。此配置会自动为连接到 Locator 的集群成员上定义的每个 Region 创建客户端 Region bean,因此它们可以被 Spring Data 映射注释 (GemfireTemplate) 无缝引用,并自动注入到应用程序类中。

当然,您可以显式地配置客户端 Region。例如,如果您想在本地内存中缓存数据,如下例所示

<gfe-data:datasource>
  <locator host="remotehost" port="1234"/>
</gfe-data:datasource>

<gfe:client-region id="Example" shortcut="CACHING_PROXY"/>

5.4. 配置缓存

要使用 Apache Geode,您需要创建一个新的缓存或连接到现有的缓存。使用当前版本的 Apache Geode,您每个 VM(更严格地说,每个 ClassLoader)只能有一个打开的缓存。在大多数情况下,缓存应该只创建一次。

本节描述了对等 Cache 成员的创建和配置,适用于点对点 (P2P) 拓扑和缓存服务器。Cache 成员也可以在独立应用程序和集成测试中使用。但是,在典型的生产系统中,大多数应用程序进程充当缓存客户端,创建 ClientCache 实例。这在 配置 Apache Geode ClientCache客户端 Region 部分进行了描述。

可以使用以下简单声明创建具有默认配置的对等 Cache

<gfe:cache/>

在 Spring 容器初始化期间,任何包含此缓存定义的 `ApplicationContext` 会注册一个 `CacheFactoryBean`,该工厂创建名为 `gemfireCache` 的 Spring Bean,它引用一个 Apache Geode `Cache` 实例。此 Bean 引用一个已存在的 `Cache`,或者如果不存在则创建一个新的 `Cache`。由于没有指定其他属性,新创建的 `Cache` 会应用默认的缓存配置。

所有依赖 `Cache` 的 Spring Data for Apache Geode 组件都遵循此命名约定,因此您无需显式声明 `Cache` 依赖项。如果您愿意,可以使用各种 SDG XML 命名空间元素提供的 `cache-ref` 属性来显式声明依赖项。此外,您可以使用 `id` 属性覆盖缓存的 Bean 名称,如下所示

<gfe:cache id="myCache"/>

可以使用 Spring 全面配置 Apache Geode `Cache`。但是,Apache Geode 的原生 XML 配置文件 `cache.xml` 也受支持。对于需要原生配置 Apache Geode 缓存的情况,可以使用 `cache-xml-location` 属性提供对 Apache Geode XML 配置文件的引用,如下所示

<gfe:cache id="cacheConfiguredWithNativeCacheXml" cache-xml-location="classpath:cache.xml"/>

在此示例中,如果需要创建缓存,它会使用类路径根目录中名为 `cache.xml` 的文件来配置它。

该配置利用 Spring 的 Resource 抽象来定位文件。`Resource` 抽象允许使用各种搜索模式,具体取决于运行时环境或资源位置中指定的(如果有)前缀。

除了引用外部 XML 配置文件之外,您还可以指定 Apache Geode 系统 属性,这些属性使用 Spring 的任何 `Properties` 支持功能。

例如,您可以使用 `util` 命名空间中定义的 `properties` 元素直接定义 `Properties` 或从属性文件加载属性,如下所示

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:gfe="https://www.springframework.org/schema/geode"
       xmlns:util="http://www.springframework.org/schema/util"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="
    http://www.springframework.org/schema/beans https://www.springframework.org/schema/beans/spring-beans.xsd
    https://www.springframework.org/schema/geode https://www.springframework.org/schema/geode/spring-geode.xsd
    http://www.springframework.org/schema/util https://www.springframework.org/schema/util/spring-util.xsd
">

  <util:properties id="gemfireProperties" location="file:/path/to/gemfire.properties"/>

  <gfe:cache properties-ref="gemfireProperties"/>

</beans>

建议使用属性文件将特定于环境的设置外部化到应用程序配置之外。

缓存设置仅在需要创建新缓存时应用。如果虚拟机中已存在打开的缓存,则会忽略这些设置。

5.4.1. 高级缓存配置

对于高级缓存配置,cache 元素提供了一些配置选项,这些选项以属性或子元素的形式公开,如下所示

(1)
<gfe:cache
    cache-xml-location=".."
    properties-ref=".."
    close="false"
    copy-on-read="true"
    critical-heap-percentage="90"
    eviction-heap-percentage="70"
    enable-auto-reconnect="false" (2)
    lock-lease="120"
    lock-timeout="60"
    message-sync-interval="1"
    pdx-serializer-ref="myPdxSerializer"
    pdx-persistent="true"
    pdx-disk-store="diskStore"
    pdx-read-serialized="false"
    pdx-ignore-unread-fields="true"
    search-timeout="300"
    use-bean-factory-locator="true" (3)
    use-cluster-configuration="false" (4)
>

  <gfe:transaction-listener ref="myTransactionListener"/> (5)

  <gfe:transaction-writer> (6)
    <bean class="org.example.app.gemfire.transaction.TransactionWriter"/>
  </gfe:transaction-writer>

  <gfe:gateway-conflict-resolver ref="myGatewayConflictResolver"/> (7)

  <gfe:jndi-binding jndi-name="myDataSource" type="ManagedDataSource"/> (8)

</gfe:cache>
1 属性支持各种缓存选项。有关此示例中显示的任何内容的更多信息,请参阅 Apache Geode 产品文档close 属性决定在 Spring 应用程序上下文关闭时是否应关闭缓存。默认值为 true。但是,对于多个应用程序上下文使用缓存的用例(在 Web 应用程序中很常见),请将此值设置为 false
2 enable-auto-reconnect 属性设置为 true(默认值为 false)允许断开的 Apache Geode 成员自动重新连接并重新加入 Apache Geode 集群。有关更多详细信息,请参阅 Apache Geode 产品文档
3 use-bean-factory-locator 属性设置为 true(默认值为 false)仅在使用 Spring(XML)配置元数据和 Apache Geode cache.xml 配置 Apache Geode 缓存节点(无论是客户端还是对等节点)时才适用。此选项允许在 cache.xml 中表达的 Apache Geode 组件(例如 CacheLoader)使用 Spring 应用程序上下文中定义的 bean(例如 DataSource)自动装配。此选项通常与 cache-xml-location 结合使用。
4 use-cluster-configuration 属性设置为 true(默认值为 false)使 Apache Geode 成员能够从定位器检索通用的共享基于集群的配置。有关更多详细信息,请参阅 Apache Geode 产品文档
5 使用 bean 引用声明 TransactionListener 回调的示例。引用的 bean 必须实现 TransactionListener。可以实现 TransactionListener 来处理与事务相关的事件(例如 afterCommit 和 afterRollback)。
6 使用内部 bean 声明声明 TransactionWriter 回调的示例。该 bean 必须实现 TransactionWriterTransactionWriter 是一个回调,可以否决事务。
7 这是一个使用 Bean 引用声明 GatewayConflictResolver 回调的示例。引用的 Bean 必须实现 https://geode.apache.org/releases/latest/javadoc/org/apache/geode/cache/util/GatewayConflictResolver.html [GatewayConflictResolver]。GatewayConflictResolver 是一个 Cache 级别的插件,用于决定如何处理来自其他系统并通过 WAN 网关到达的事件,该网关提供分布式 Region 创建服务。
8 声明一个 JNDI 绑定,以将外部数据源注册到 Apache Geode 事务中。
启用 PDX 序列化

上面的示例包含许多与 Apache Geode 的增强序列化框架 PDX 相关的属性。虽然本参考指南无法全面讨论 PDX,但重要的是要注意,PDX 是通过注册 PdxSerializer 来启用的,该序列化器由设置 pdx-serializer 属性指定。

Apache Geode 提供了一个实现类 (org.apache.geode.pdx.ReflectionBasedAutoSerializer),它使用 Java 反射。但是,开发人员通常会提供自己的实现。该属性的值只是一个对实现 PdxSerializer 接口的 Spring Bean 的引用。

有关序列化支持的更多信息,请参阅 使用 Apache Geode 序列化

启用自动重新连接

<gfe:cache enable-auto-reconnect="[true|false*]> 属性设置为 true 时,应谨慎操作。

通常,仅在使用 Spring Data for Apache Geode 的 XML 命名空间配置和引导添加到集群中的新非应用程序 Apache Geode 服务器时,才应启用“自动重新连接”。换句话说,当 Spring Data for Apache Geode 用于开发和构建 Apache Geode 应用程序时,该应用程序恰好也是 Apache Geode 集群的同级 Cache 成员,则不应启用“自动重新连接”。

此限制的主要原因是,大多数 Apache Geode 应用程序使用对 Apache Geode Cache 或 Region 的引用来执行数据访问操作。这些引用由 Spring 容器“注入”到应用程序组件(例如存储库)中,供应用程序使用。当同级成员被强制从集群的其余部分断开连接时,可能是因为同级成员变得无响应或网络分区将一个或多个同级成员分离到一个太小而无法作为独立分布式系统运行的组中,同级成员将关闭,并且所有 Apache Geode 组件引用(缓存、Region 等)将变得无效。

本质上,每个同级成员中的当前强制断开连接处理逻辑会从头开始拆卸系统。JGroups 堆栈关闭,分布式系统进入关闭状态,最后缓存关闭。实际上,所有内存引用都已过时并丢失。

在从分布式系统断开连接后,同级成员进入“重新连接”状态,并定期尝试重新加入分布式系统。如果同级成员成功重新连接,则成员将从现有成员重建其对分布式系统的“视图”,并接收新的分布式系统 ID。此外,所有缓存、Region 和其他 Apache Geode 组件都将重建。因此,所有可能已由 Spring 容器注入到应用程序中的旧引用现在已过时且不再有效。

Apache Geode 不保证(即使使用 Apache Geode 公共 Java API)应用程序缓存、区域或其他组件引用会通过重新连接操作自动刷新。因此,Apache Geode 应用程序必须注意刷新自己的引用。

不幸的是,没有办法收到断开连接事件的通知,以及随后重新连接事件的通知。如果是这样,您将有一个清晰的方法来知道何时调用 `ConfigurableApplicationContext.refresh()`,即使它适用于应用程序这样做,这也是为什么 Apache Geode 的此“功能”不推荐用于对等 `Cache` 应用程序的原因。

有关“自动重新连接”的更多信息,请参阅 Apache Geode 的 产品文档

使用基于集群的配置

Apache Geode 的集群配置服务是任何加入集群的对等成员通过使用定位器维护的共享持久配置来获取集群“一致视图”的便捷方式。使用基于集群的配置可确保对等成员的配置在成员加入时与 Apache Geode 分布式系统兼容。

Spring Data for Apache Geode 的此功能(将 `use-cluster-configuration` 属性设置为 `true`)的工作方式与 `cache-xml-location` 属性相同,只是 Apache Geode 配置元数据的来源来自网络通过定位器,而不是本地 `cache.xml` 文件驻留在本地文件系统中。

所有 Apache Geode 本地配置元数据,无论是来自 `cache.xml` 还是来自集群配置服务,都会在任何 Spring(XML)配置元数据之前应用。因此,Spring 的配置用于“增强”本地 Apache Geode 配置元数据,并且很可能特定于应用程序。

同样,要启用此功能,请在 Spring XML 配置中指定以下内容

<gfe:cache use-cluster-configuration="true"/>
虽然某些 Apache Geode 工具(如 *Gfsh*)在进行类似模式的更改(例如,`gfsh>create region --name=Example --type=PARTITION`)时会“记录”其操作,但 Spring Data for Apache Geode 的配置元数据不会被记录。直接使用 Apache Geode 的公共 Java API 时也是如此。它也不会被记录。

有关 Apache Geode 的集群配置服务的更多信息,请参阅 产品文档

5.4.2. 配置 Apache Geode CacheServer

Spring Data for Apache Geode 包含对配置 CacheServer 的专用支持,允许通过 Spring 容器进行完整配置,如下例所示

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:gfe="https://www.springframework.org/schema/geode"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="
    http://www.springframework.org/schema/beans https://www.springframework.org/schema/beans/spring-beans.xsd
    http://www.springframework.org/schema/context https://www.springframework.org/schema/context/spring-context.xsd
    https://www.springframework.org/schema/geode https://www.springframework.org/schema/geode/spring-geode.xsd
">

  <gfe:cache/>

  <!-- Example depicting serveral Apache Geode CacheServer configuration options -->
  <gfe:cache-server id="advanced-config" auto-startup="true"
       bind-address="localhost" host-name-for-clients="localhost" port="${gemfire.cache.server.port}"
       load-poll-interval="2000" max-connections="22" max-message-count="1000" max-threads="16"
       max-time-between-pings="30000" groups="test-server">

    <gfe:subscription-config eviction-type="ENTRY" capacity="1000" disk-store="file://${java.io.tmpdir}"/>

  </gfe:cache-server>

  <context:property-placeholder location="classpath:cache-server.properties"/>

</beans>

前面的配置显示了 cache-server 元素和许多可用选项。

此配置不使用硬编码端口,而是使用 Spring 的 context 命名空间来声明 property-placeholder。一个 property placeholder 读取一个或多个属性文件,然后在运行时用值替换属性占位符。这样做可以让管理员更改值,而无需触碰主应用程序配置。Spring 还提供 SpEL环境抽象 来支持从主代码库中外部化环境特定的属性,从而简化跨多个机器的部署。
为了避免初始化问题,Spring Data for Apache Geode 启动的 CacheServer 在 Spring 容器完全初始化 **之后** 启动。这样做可以让在声明式定义的潜在区域、监听器、写入器或实例化器在服务器开始接受连接之前完全初始化和注册。在以编程方式配置这些元素时请记住这一点,因为服务器可能会在您的组件之前启动,因此客户端可能无法立即看到它们。

5.4.3. 配置 Apache Geode 客户端缓存

除了定义 Apache Geode 对等 Cache 之外,Spring Data for Apache Geode 还支持在 Spring 容器中定义 Apache Geode ClientCacheClientCache 定义在配置和使用方面类似于 Apache Geode 对等 Cache,并由 org.springframework.data.gemfire.client.ClientCacheFactoryBean 支持。

使用默认配置定义 Apache Geode 缓存客户端的最简单方法如下

<beans>
  <gfe:client-cache/>
</beans>

client-cache 支持许多与 Cache 元素相同的选项。但是,与完整的对等 Cache 成员不同,缓存客户端通过 Pool 连接到远程缓存服务器。默认情况下,将创建一个 Pool 来连接到运行在 localhost 上并监听端口 40404 的服务器。所有客户端 Region 都使用默认 Pool,除非 Region 配置为使用特定 Pool。

可以使用 pool 元素定义 Pool。此客户端池可用于直接配置与服务器的连接,以用于单个实体或通过一个或多个 Locator 用于整个缓存。

例如,要自定义 client-cache 使用的默认 Pool,开发人员需要定义一个 Pool 并将其连接到缓存定义,如下面的示例所示

<beans>
  <gfe:client-cache id="myCache" pool-name="myPool"/>

  <gfe:pool id="myPool" subscription-enabled="true">
    <gfe:locator host="${gemfire.locator.host}" port="${gemfire.locator.port}"/>
  </gfe:pool>
</beans>

<client-cache> 元素还具有 ready-for-events 属性。如果将该属性设置为 true,则客户端缓存初始化将包括对 ClientCache.readyForEvents() 的调用。

客户端 Region 更详细地介绍了客户端配置。

Apache Geode 的 DEFAULT 池和 Spring Data for Apache Geode 池定义

如果 Apache Geode ClientCache 仅限本地,则不需要池定义。例如,您可以定义以下内容

<gfe:client-cache/>

<gfe:client-region id="Example" shortcut="LOCAL"/>

在这种情况下,“Example” Region 为 LOCAL,并且客户端和服务器之间没有数据分发。因此,不需要池。对于任何客户端侧、仅限本地的 Region,情况都是如此,如 Apache Geode 的 ClientRegionShortcut(所有 LOCAL_* 快捷方式)所定义。

但是,如果客户端 Region 是服务器端 Region 的(缓存)代理,则需要池。在这种情况下,有几种方法可以定义和使用池。

ClientCache、池和基于代理的 Region 都已定义但未明确标识时,Spring Data for Apache Geode 会自动解析引用,如下面的示例所示

<gfe:client-cache/>

<gfe:pool>
  <gfe:locator host="${geode.locator.host}" port="${geode.locator.port}"/>
</gfe:pool>

<gfe:client-region id="Example" shortcut="PROXY"/>

在前面的示例中,ClientCache 被标识为 gemfireCache,池被标识为 gemfirePool,客户端 Region 被标识为“Example”。但是,ClientCachegemfirePool 初始化 Apache Geode 的 DEFAULT 池,并且客户端 Region 在客户端和服务器之间分发数据时使用 gemfirePool

基本上,Spring Data for Apache Geode 将前面的配置解析为以下内容

<gfe:client-cache id="gemfireCache" pool-name="gemfirePool"/>

<gfe:pool id="gemfirePool">
  <gfe:locator host="${geode.locator.host}" port="${geode.locator.port}"/>
</gfe:pool>

<gfe:client-region id="Example" cache-ref="gemfireCache" pool-name="gemfirePool" shortcut="PROXY"/>

Apache Geode 仍然会创建一个名为 DEFAULT 的池。Spring Data for Apache Geode 会导致 DEFAULT 池从 gemfirePool 初始化。这样做在定义了多个池并且客户端区域使用不同的池或根本没有声明池的情况下很有用。

考虑以下情况

<gfe:client-cache pool-name="locatorPool"/>

<gfe:pool id="locatorPool">
  <gfe:locator host="${geode.locator.host}" port="${geode.locator.port}"/>
</gfe:pool>

<gfe:pool id="serverPool">
  <gfe:server host="${geode.server.host}" port="${geode.server.port}"/>
</gfe:pool>

<gfe:client-region id="Example" pool-name="serverPool" shortcut="PROXY"/>

<gfe:client-region id="AnotherExample" shortcut="CACHING_PROXY"/>

<gfe:client-region id="YetAnotherExample" shortcut="LOCAL"/>

在此设置中,Apache Geode client-cache DEFAULT 池从 locatorPool 初始化,如 pool-name 属性指定的那样。由于两个池都被明确标识(命名)——分别为 locatorPoolserverPool,因此没有 Spring Data for Apache Geode 定义的 gemfirePool

“Example” 区域明确引用并专门使用 serverPoolAnotherExample 区域使用 Apache Geode 的 DEFAULT 池,该池再次根据客户端缓存 bean 定义的 pool-name 属性从 locatorPool 配置。

最后,YetAnotherExample 区域不使用池,因为它为 LOCAL

AnotherExample 区域将首先查找名为 gemfirePool 的池 bean,但这将需要定义一个匿名池 bean(即 <gfe:pool/>)或一个明确命名为 gemfirePool 的池 bean(例如,<gfe:pool id="gemfirePool"/>)。
如果我们将 locatorPool 的名称更改为 gemfirePool 或使池 bean 定义成为匿名,它将与前面的配置具有相同的效果。

5.5. 配置区域

区域是用于存储和检索缓存中数据的必需组件。org.apache.geode.cache.Region 是一个扩展 java.util.Map 的接口,它使用熟悉的键值语义启用基本数据访问。Region 接口连接到需要它的应用程序类,因此实际的区域类型与编程模型分离。通常,每个区域都与一个域对象相关联,类似于关系数据库中的表。

Apache Geode 实现以下类型的区域

  • REPLICATE - 数据在定义区域的集群中所有缓存成员之间复制。这提供了非常高的读取性能,但写入需要更长时间来执行复制。

  • PARTITION - 数据在定义区域的集群中许多缓存成员之间划分为桶(分片)。这提供了高读取和写入性能,适用于单个节点无法容纳的大型数据集。

  • LOCAL - 数据仅存在于本地节点上。

  • Client - 从技术上讲,客户端区域是一个 LOCAL 区域,充当托管在集群中缓存服务器上的 REPLICATE 或 PARTITION 区域的代理。它可能保存本地创建或获取的数据。或者,它可以为空。本地更新与缓存服务器同步。此外,客户端区域可以订阅事件,以便与访问同一服务器区域的远程进程发起的更改保持同步(同步)。

有关各种区域类型及其功能以及配置选项的更多信息,请参阅 Apache Geode 关于 区域类型 的文档。

5.5.1. 使用外部配置的区域

要引用已在 Apache Geode 本机 cache.xml 文件中配置的区域,请使用 lookup-region 元素。只需使用 name 属性声明目标区域名称。例如,要声明一个标识为 ordersRegion 的 bean 定义,用于名为 Orders 的现有区域,可以使用以下 bean 定义

<gfe:lookup-region id="ordersRegion" name="Orders"/>

如果未指定 name,则 bean 的 id 将用作区域的名称。上面的示例变为

<!-- lookup for a Region called 'Orders' -->
<gfe:lookup-region id="Orders"/>
如果区域不存在,将抛出初始化异常。要配置新区域,请继续执行以下相应部分。

在前面的示例中,由于没有明确定义缓存名称,因此使用了默认命名约定 (gemfireCache)。或者,可以使用 cache-ref 属性引用缓存 bean

<gfe:cache id="myCache"/>
<gfe:lookup-region id="ordersRegion" name="Orders" cache-ref="myCache"/>

lookup-region 允许您检索现有的预配置区域,而无需公开区域语义或设置基础结构。

5.5.2. 自动区域查找

auto-region-lookup 允许您在 <gfe:cache> 元素上使用 cache-xml-location 属性时,将 Apache Geode 本机 cache.xml 文件中定义的所有区域导入到 Spring ApplicationContext 中。

例如,请考虑以下 cache.xml 文件

<?xml version="1.0" encoding="UTF-8"?>
<cache xmlns="https://geode.apache.org/schema/cache"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://geode.apache.org/schema/cache https://geode.apache.org/schema/cache/cache-1.0.xsd"
       version="1.0">

  <region name="Parent" refid="REPLICATE">
    <region name="Child" refid="REPLICATE"/>
  </region>

</cache>

您可以按如下方式导入前面的 cache.xml 文件

<gfe:cache cache-xml-location="cache.xml"/>

然后,您可以使用 <gfe:lookup-region> 元素(例如,<gfe:lookup-region id="Parent"/>)将特定区域引用为 Spring 容器中的 bean,或者您可以选择通过使用以下方法导入 cache.xml 中定义的所有区域

<gfe:auto-region-lookup/>

Spring Data for Apache Geode 会自动为 cache.xml 中定义的所有 Apache Geode 区域创建 bean,这些区域尚未通过显式 <gfe:lookup-region> bean 声明显式添加到 Spring 容器中。

重要的是要意识到,Spring Data for Apache Geode 使用 Spring BeanPostProcessor 在缓存创建和初始化后对其进行后处理,以确定在 Apache Geode 中定义的区域,以将其作为 bean 添加到 Spring ApplicationContext 中。

您可以像注入任何其他在 Spring ApplicationContext 中定义的 bean 一样注入这些“自动查找”的 Region,只有一个例外:您可能需要定义一个与“gemfireCache” bean 的 depends-on 关联,如下所示

package example;

import ...

@Repository("appDao")
@DependsOn("gemfireCache")
public class ApplicationDao extends DaoSupport {

    @Resource(name = "Parent")
    private Region<?, ?> parent;

    @Resource(name = "/Parent/Child")
    private Region<?, ?> child;

    ...
}

前面的示例仅适用于您使用 Spring 的 component-scan 功能时。

如果您使用 Spring XML 配置声明组件,则您将执行以下操作

<bean class="example.ApplicationDao" depends-on="gemfireCache"/>

这样做可以确保 Apache Geode 缓存和在 cache.xml 中定义的所有 Region 在使用 <gfe:auto-region-lookup> 元素时,在任何具有自动连接引用的组件之前创建。

5.5.3. 配置 Region

Spring Data for Apache Geode 通过以下元素为配置任何类型的 Region 提供全面支持

  • LOCAL Region:<local-region>

  • PARTITION Region:<partitioned-region>

  • REPLICATE Region:<replicated-region>

  • Client Region:<client-region>

有关 Region 类型 的全面描述,请参阅 Apache Geode 文档。

通用 Region 属性

下表列出了所有 Region 类型可用的属性

表 1. 通用 Region 属性
名称 描述

cache-ref

Apache Geode 缓存 bean 引用

定义 Apache Geode 缓存的 bean 的名称(默认情况下为“gemfireCache”)。

cloning-enabled

布尔值(默认:false

当为 true 时,更新将应用于值的克隆,然后克隆将保存到缓存中。当为 false 时,将对缓存中的值进行就地修改。

close

布尔值(默认:false

确定是否应在关闭时关闭区域。

concurrency-checks-enabled

布尔值(默认:true

确定成员是否执行检查以提供对分布式区域的并发或乱序更新的一致处理。

data-policy

请参阅 Apache Geode 的 数据策略

区域的数据策略。请注意,并非所有数据策略都支持每种 Region 类型。

destroy

布尔值(默认:false

确定在关闭时是否应销毁区域。

disk-store-ref

已配置磁盘存储的名称。

对通过disk-store元素创建的 bean 的引用。

disk-synchronous

布尔值(默认:true

确定磁盘存储写入是否同步。

id

任何有效的 bean 名称。

如果未指定name属性,则为默认区域名称。

ignore-if-exists

布尔值(默认:false

如果区域已存在于缓存中,则忽略此 bean 定义,从而导致查找而不是创建。

ignore-jta

布尔值(默认:false

确定此区域是否参与 JTA(Java 事务 API)事务。

index-update-type

synchronousasynchronous(默认:synchronous

确定在条目创建时是否同步或异步更新索引。

initial-capacity

整数(默认:16)

区域条目的数量的初始内存分配。

key-constraint

任何有效的完全限定 Java 类名。

预期的键类型。

load-factor

浮点数(默认:.75)

设置用于存储区域条目的底层java.util.ConcurrentHashMap的初始参数。

name

任何有效的区域名称。

区域的名称。如果未指定,则假定为id属性的值(即 bean 名称)。

persistent

*布尔值(默认:false

确定区域是否将条目持久保存到本地磁盘(磁盘存储)。

shortcut

参见https://geode.apache.org/releases/latest/javadoc/org/apache/geode/cache/RegionShortcut.html

此区域的RegionShortcut。允许根据预定义的默认值轻松初始化区域。

statistics

布尔值(默认:false

确定区域是否报告统计信息。

template

区域模板的名称。

对通过*region-template元素之一创建的 bean 的引用。

value-constraint

任何有效的完全限定 Java 类名。

预期的值类型。

CacheListener实例

CacheListener实例注册到区域以处理区域事件,例如创建、更新、销毁条目等。CacheListener可以是实现CacheListener接口的任何 bean。区域可以有多个侦听器,这些侦听器通过包含在包含*-region元素中的cache-listener元素中声明。

以下示例有两个声明的CacheListener。第一个引用命名、顶级 Spring bean。第二个是匿名内部 bean 定义。

<bean id="myListener" class="org.example.app.geode.cache.SimpleCacheListener"/>

<gfe:replicated-region id="regionWithListeners">
  <gfe:cache-listener>
    <!-- nested CacheListener bean reference -->
    <ref bean="myListener"/>
    <!-- nested CacheListener bean definition -->
    <bean class="org.example.app.geode.cache.AnotherSimpleCacheListener"/>
  </gfe:cache-listener>
</gfe:replicated-region>

以下示例使用带有ref属性的cache-listener元素的另一种形式。这样做允许在定义单个CacheListener时进行更简洁的配置。

注意:XML 命名空间只允许一个cache-listener元素,因此必须使用前面示例中显示的样式或以下示例中的样式。

<beans>
  <gfe:replicated-region id="exampleReplicateRegionWithCacheListener">
    <gfe:cache-listener ref="myListener"/>
  </gfe:replicated-region>

  <bean id="myListener" class="example.CacheListener"/>
</beans>
cache-listener元素中使用ref和嵌套声明是非法的。这两个选项是互斥的,在同一个元素中使用两者会导致异常。
Bean 引用约定

cache-listener元素是 Apache Geode 在 XML 命名空间中使用的常见模式的一个示例,它提供回调接口以在响应缓存或区域事件时调用自定义代码。当您使用 Spring 的 IoC 容器时,实现是一个标准的 Spring bean。为了简化配置,模式允许cache-listener元素出现一次,但是,如果允许多个实例,它可以包含嵌套的 bean 引用和内部 bean 定义的任何组合。约定是使用单数形式(即cache-listener vs cache-listeners),反映最常见的场景实际上是一个实例。我们已经在高级缓存配置示例中看到了这种模式的示例。

CacheLoaders 和 CacheWriters

cache-listener类似,XML 命名空间提供cache-loadercache-writer元素来为区域注册这些 Apache Geode 组件。

CacheLoader在缓存未命中时被调用,以允许从外部数据源(如数据库)加载条目。CacheWriter在创建或更新条目之前被调用,以允许将条目同步到外部数据源。主要区别在于 Apache Geode 最多支持每个区域一个CacheLoaderCacheWriter实例。但是,可以使用任一声明样式。

以下示例声明了一个同时具有CacheLoaderCacheWriter的区域

<beans>
  <gfe:replicated-region id="exampleReplicateRegionWithCacheLoaderAndCacheWriter">
    <gfe:cache-loader ref="myLoader"/>
    <gfe:cache-writer>
      <bean class="example.CacheWriter"/>
    </gfe:cache-writer>
  </gfe:replicated-region>

  <bean id="myLoader" class="example.CacheLoader">
    <property name="dataSource" ref="mySqlDataSource"/>
  </bean>

  <!-- DataSource bean definition -->
</beans>

有关更多详细信息,请参阅 Apache Geode 文档中的CacheLoaderCacheWriter

5.5.4. 压缩

Apache Geode 区域也可以被压缩,以减少 JVM 内存消耗和压力,从而可能避免全局 GC。当您为区域启用压缩时,存储在区域内存中的所有值都会被压缩,而键和索引保持未压缩。新值在放入区域时被压缩,所有值在从区域读回时自动解压缩。值在持久化到磁盘或通过网络发送到其他对等成员或客户端时不会被压缩。

以下示例显示了一个启用了压缩的区域

<beans>
  <gfe:replicated-region id="exampleReplicateRegionWithCompression">
    <gfe:compressor>
      <bean class="org.apache.geode.compression.SnappyCompressor"/>
    </gfe:compressor>
  </gfe:replicated-region>
</beans>

有关区域压缩的更多信息,请参阅 Apache Geode 的文档。

5.5.5. 堆外内存

Apache Geode 区域也可以配置为将区域值存储在堆外内存中,堆外内存是 JVM 内存的一部分,不受垃圾回收 (GC) 的影响。通过避免昂贵的 GC 周期,您的应用程序可以将更多时间花在重要的事情上,例如处理请求。

使用堆外内存就像声明要使用的内存量,然后启用您的区域使用堆外内存一样简单,如下面的配置所示

<util:properties id="gemfireProperties">
    <prop key="off-heap-memory-size">200G</prop>
</util:properties>

<gfe:cache properties-ref="gemfireProperties"/>

<gfe:partitioned-region id="ExampleOffHeapRegion" off-heap="true"/>

您可以通过使用 <gfe:cache> 元素设置以下 Apache Geode 配置属性来控制堆外内存管理的其他方面:

<gfe:cache critical-off-heap-percentage="90" eviction-off-heap-percentage"80"/>

Apache Geode 的 ResourceManager 将使用这两个阈值(critical-off-heap-percentageeviction-off-heap-percentage)更有效地管理堆外内存,就像 JVM 管理堆内存一样。Apache Geode ResourceManager 将通过逐出旧数据来防止缓存消耗过多的堆外内存。如果堆外内存管理器无法跟上,那么 ResourceManager 会拒绝向缓存添加内容,直到堆外内存管理器释放了足够的内存。

有关 管理堆内存和堆外内存 的更多信息,请参阅 Apache Geode 文档。

具体来说,请阅读 管理堆外内存 部分。

5.5.6. 子区域

Spring Data for Apache Geode 还支持子区域,允许区域以层次结构关系排列。

例如,Apache Geode 允许使用 /Customer/Address 区域和不同的 /Employee/Address 区域。此外,子区域可以有自己的子区域和配置。子区域不会从其父区域继承属性。区域类型可以根据 Apache Geode 约束进行混合和匹配。子区域自然地声明为区域的子元素。子区域的 name 属性是简单名称。前面的示例可以配置如下

<beans>
  <gfe:replicated-region name="Customer">
    <gfe:replicated-region name="Address"/>
  </gfe:replicated-region>

  <gfe:replicated-region name="Employee">
    <gfe:replicated-region name="Address"/>
  </gfe:replicated-region>
</beans>

请注意,Monospaced ([id]) 属性不允许用于子区域。子区域使用 bean 名称(在本例中分别为 /Customer/Address 和 /Employee/Address)创建。因此,它们可以通过使用区域的完整路径名注入到其他应用程序 bean 中,例如需要它们的 GemfireTemplate。区域的完整路径名也应在 OQL 查询字符串中使用。

5.5.7. 区域模板

Spring Data for Apache Geode 也支持区域模板。

此功能允许开发人员定义通用的区域配置和属性,并在 Spring ApplicationContext 中声明的多个区域 Bean 定义中重用该配置。

Spring Data for Apache Geode 在其命名空间中包含五个区域模板标签

表 2. 区域模板标签
标签名称 描述

<gfe:region-template>

定义通用的区域属性。扩展 XML 命名空间中的 regionType

<gfe:local-region-template>

定义通用的“本地”区域属性。扩展 XML 命名空间中的 localRegionType

<gfe:partitioned-region-template>

定义通用的“分区”区域属性。扩展 XML 命名空间中的 partitionedRegionType

<gfe:replicated-region-template>

定义通用的“复制”区域属性。扩展 XML 命名空间中的 replicatedRegionType

<gfe:client-region-template>

定义通用的“客户端”区域属性。扩展 XML 命名空间中的 clientRegionType

除了标签之外,具体的 <gfe:*-region> 元素(以及抽象的 <gfe:*-region-template> 元素)具有一个 template 属性,用于定义区域从其继承配置的区域模板。区域模板甚至可以从其他区域模板继承。

以下示例显示了一种可能的配置

<beans>
  <gfe:async-event-queue id="AEQ" persistent="false" parallel="false" dispatcher-threads="4">
    <gfe:async-event-listener>
      <bean class="example.AeqListener"/>
    </gfe:async-event-listener>
  </gfe:async-event-queue>

  <gfe:region-template id="BaseRegionTemplate" initial-capacity="51" load-factor="0.85" persistent="false" statistics="true"
      key-constraint="java.lang.Long" value-constraint="java.lang.String">
    <gfe:cache-listener>
      <bean class="example.CacheListenerOne"/>
      <bean class="example.CacheListenerTwo"/>
    </gfe:cache-listener>
    <gfe:entry-ttl timeout="600" action="DESTROY"/>
    <gfe:entry-tti timeout="300 action="INVLIDATE"/>
  </gfe:region-template>

  <gfe:region-template id="ExtendedRegionTemplate" template="BaseRegionTemplate" load-factor="0.55">
    <gfe:cache-loader>
      <bean class="example.CacheLoader"/>
    </gfe:cache-loader>
    <gfe:cache-writer>
      <bean class="example.CacheWriter"/>
    </gfe:cache-writer>
    <gfe:async-event-queue-ref bean="AEQ"/>
  </gfe:region-template>

  <gfe:partitioned-region-template id="PartitionRegionTemplate" template="ExtendedRegionTemplate"
      copies="1" load-factor="0.70" local-max-memory="1024" total-max-memory="16384" value-constraint="java.lang.Object">
    <gfe:partition-resolver>
      <bean class="example.PartitionResolver"/>
    </gfe:partition-resolver>
    <gfe:eviction type="ENTRY_COUNT" threshold="8192000" action="OVERFLOW_TO_DISK"/>
  </gfe:partitioned-region-template>

  <gfe:partitioned-region id="TemplateBasedPartitionRegion" template="PartitionRegionTemplate"
      copies="2" local-max-memory="8192" persistent="true" total-buckets="91"/>
</beans>

区域模板也适用于子区域。请注意,“TemplateBasedPartitionRegion” 扩展了“PartitionRegionTemplate”,后者扩展了“ExtendedRegionTemplate”,后者扩展了“BaseRegionTemplate”。在后续继承的区域 Bean 定义中定义的属性和子元素会覆盖父元素中的内容。

模板工作原理

Spring Data for Apache Geode 在解析 Spring ApplicationContext 配置元数据时应用区域模板,因此,必须按继承顺序声明区域模板。换句话说,父模板必须在子模板之前定义。这样做可以确保应用正确的配置,尤其是在元素属性或子元素被覆盖时。

同样重要的是要记住,区域类型只能从其他类似类型的区域继承。例如,<gfe:replicated-region> 无法从 <gfe:partitioned-region-template> 继承。
区域模板是单继承的。
关于区域、子区域和查找的注意事项

以前,在 Spring Data for Apache Geode XML 命名空间中,replicated-regionpartitioned-regionlocal-regionclient-region 元素的底层属性之一是在尝试创建区域之前先执行查找。这样做是为了防止区域已经存在的情况,这种情况可能发生在区域是在导入的 Apache Geode 原生 cache.xml 配置文件中定义的情况下。因此,首先执行查找以避免任何错误。这是设计使然,可能会发生变化。

此行为已更改,默认行为现在是先创建区域。如果区域已存在,则创建逻辑会快速失败并抛出相应的异常。但是,与 CREATE TABLE IF NOT EXISTS …​ DDL 语法类似,Spring Data for Apache Geode <gfe:*-region> XML 命名空间元素现在包含一个 ignore-if-exists 属性,该属性通过首先查找由名称标识的现有区域来恢复旧行为,然后再尝试创建区域。如果通过名称找到了现有区域,并且 ignore-if-exists 设置为 true,则在 Spring 配置中定义的区域 bean 定义将被忽略。

Spring 团队强烈建议仅将 replicated-regionpartitioned-regionlocal-regionclient-region XML 命名空间元素用于定义新区域。当这些元素定义的区域已存在并且区域元素首先执行查找时,可能会出现的一个问题是,如果您在应用程序配置中为驱逐、过期、订阅等定义了不同的区域语义和行为,那么区域定义可能不匹配,并且可能表现出与应用程序所需的相反行为。更糟糕的是,您可能希望将区域定义为分布式区域(例如,PARTITION),而实际上,现有的区域定义仅是本地的。
推荐做法 - 仅使用 replicated-regionpartitioned-regionlocal-regionclient-region XML 命名空间元素来定义新区域。

请考虑以下原生 Apache Geode cache.xml 配置文件

<?xml version="1.0" encoding="UTF-8"?>
<cache xmlns="https://geode.apache.org/schema/cache"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://geode.apache.org/schema/cache https://geode.apache.org/schema/cache/cache-1.0.xsd"
       version="1.0">

  <region name="Customers" refid="REPLICATE">
    <region name="Accounts" refid="REPLICATE">
      <region name="Orders" refid="REPLICATE">
        <region name="Items" refid="REPLICATE"/>
      </region>
    </region>
  </region>

</cache>

此外,请考虑您可能已按如下方式定义了应用程序 DAO

public class CustomerAccountDao extends GemDaoSupport {

    @Resource(name = "Customers/Accounts")
    private Region customersAccounts;

    ...
}

在这里,我们在应用程序 DAO 中注入对 Customers/Accounts 区域的引用。因此,开发人员在 Spring XML 配置元数据中为这些区域中的部分或全部定义 Bean 并不罕见,如下所示

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:gfe="https://www.springframework.org/schema/geode"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="
    http://www.springframework.org/schema/beans https://www.springframework.org/schema/beans/spring-beans.xsd
    https://www.springframework.org/schema/geode https://www.springframework.org/schema/geode/spring-geode.xsd
">

  <gfe:cache cache-xml-location="classpath:cache.xml"/>

  <gfe:lookup-region name="Customers/Accounts"/>
  <gfe:lookup-region name="Customers/Accounts/Orders"/>

</beans>

Customers/AccountsCustomers/Accounts/Orders 区域在 Spring 容器中分别被引用为 Customers/AccountsCustomers/Accounts/Orders。使用 lookup-region 元素和相应的语法(前面已描述)的好处是,它允许您直接引用子区域,而无需为父区域(在本例中为 Customers)不必要地定义 Bean。

考虑以下不良示例,它将配置元数据语法更改为使用嵌套格式

<gfe:lookup-region name="Customers">
  <gfe:lookup-region name="Accounts">
    <gfe:lookup-region name="Orders"/>
  </gfe:lookup-region>
</gfe:lookup-region>

现在考虑另一个不良示例,它使用顶层 replicated-region 元素以及 ignore-if-exists 属性设置为首先执行查找

<gfe:replicated-region name="Customers" persistent="true" ignore-if-exists="true">
  <gfe:replicated-region name="Accounts" persistent="true" ignore-if-exists="true">
    <gfe:replicated-region name="Orders" persistent="true" ignore-if-exists="true"/>
  </gfe:replicated-region>
</gfe:replicated-region>

在 Spring ApplicationContext 中定义的区域 Bean 包括:{ "Customers", "/Customers/Accounts", "/Customers/Accounts/Orders" }. 这意味着前面示例中显示的依赖注入引用(即 @Resource(name = "Customers/Accounts"))现在已损坏,因为实际上没有定义名为 Customers/Accounts 的 Bean。因此,您不应按前面两个示例所示配置区域。

Apache Geode 在引用父区域和子区域时很灵活,无论是否使用前导斜杠。例如,父区域可以引用为 /CustomersCustomers,子区域可以引用为 /Customers/AccountsCustomers/Accounts。但是,Spring Data for Apache Geode 在将 Bean 命名为区域时非常具体。它始终使用正斜杠 (/) 来表示子区域(例如,/Customers/Accounts)。

因此,您应该使用前面显示的非嵌套 lookup-region 语法,或使用前导斜杠 (/) 定义直接引用,如下所示

<gfe:lookup-region name="/Customers/Accounts"/>
<gfe:lookup-region name="/Customers/Accounts/Orders"/>

前面的示例中,嵌套的 replicated-region 元素用于引用子区域,展示了前面提到的问题。Customers、Accounts 和 Orders 区域和子区域是否持久化?它们不是持久化的,因为区域是在本地 Apache Geode cache.xml 配置文件中定义为 REPLICATE,并且在缓存 Bean 初始化之前(一旦 <gfe:cache> 元素被处理)就存在。

5.5.8. 数据驱逐(带溢出)

基于各种约束,每个区域都可以拥有一个驱逐策略,用于从内存中驱逐数据。目前,在 Apache Geode 中,驱逐适用于最近最少使用条目(也称为 LRU)。被驱逐的条目要么被销毁,要么被分页到磁盘(称为“溢出到磁盘”)。

Spring Data for Apache Geode 通过使用嵌套的 eviction 元素,支持 PARTITION 区域、REPLICATE 区域以及客户端、本地区域的所有驱逐策略(条目计数、内存和堆使用)。

例如,要配置一个 PARTITION 区域,如果内存大小超过 512 MB 就溢出到磁盘,您可以指定以下配置

<gfe:partitioned-region id="examplePartitionRegionWithEviction">
  <gfe:eviction type="MEMORY_SIZE" threshold="512" action="OVERFLOW_TO_DISK"/>
</gfe:partitioned-region>
副本不能使用 local destroy 驱逐,因为这会导致它们失效。有关更多信息,请参阅 Apache Geode 文档。

在为溢出配置区域时,您应该通过 disk-store 元素配置存储,以获得最大的效率。

有关驱逐策略的详细说明,请参阅 Apache Geode 文档中的 驱逐 部分。

5.5.9. 数据过期

Apache Geode 允许您控制条目在缓存中存在的时间。过期由经过的时间驱动,而驱逐则由条目计数或堆或内存使用情况驱动。一旦条目过期,就无法再从缓存中访问它。

Apache Geode 支持以下过期类型

  • 生存时间 (TTL):对象在最后一次创建或更新后可以在缓存中保留的时间(以秒为单位)。对于条目,计数器在创建和放置操作时设置为零。区域计数器在区域创建时以及条目计数器重置时重置。

  • 空闲超时 (TTI):对象在最后一次访问后可以在缓存中保留的时间(以秒为单位)。对象的空闲超时计数器在每次其 TTL 计数器重置时重置。此外,条目的空闲超时计数器在每次通过 get 操作或 netSearch 访问条目时重置。区域的空闲超时计数器在每次其一个条目的空闲超时重置时重置。

这些都可以应用于区域本身或区域中的条目。Spring Data for Apache Geode 提供 <region-ttl><region-tti><entry-ttl><entry-tti> 区域子元素,用于指定超时值和过期操作。

以下示例展示了一个带有过期值设置的PARTITION区域

<gfe:partitioned-region id="examplePartitionRegionWithExpiration">
  <gfe:region-ttl timeout="30000" action="INVALIDATE"/>
  <gfe:entry-tti timeout="600" action="LOCAL_DESTROY"/>
</gfe:replicated-region>

有关过期策略的详细说明,请参阅 Apache Geode 文档中的过期部分。

基于注解的数据过期

使用 Spring Data for Apache Geode,您可以在单个区域条目值(或者换句话说,直接在应用程序域对象上)定义过期策略和设置。例如,您可以像下面这样在基于会话的应用程序域对象上定义过期策略

@Expiration(timeout = "1800", action = "INVALIDATE")
public class SessionBasedApplicationDomainObject {
  ...
}

您还可以使用@IdleTimeoutExpiration@TimeToLiveExpiration注解分别为空闲超时(TTI)和生存时间(TTL)过期指定区域条目上的特定过期类型设置,如下例所示

@TimeToLiveExpiration(timeout = "3600", action = "LOCAL_DESTROY")
@IdleTimeoutExpiration(timeout = "1800", action = "LOCAL_INVALIDATE")
@Expiration(timeout = "1800", action = "INVALIDATE")
public class AnotherSessionBasedApplicationDomainObject {
  ...
}

当指定多个过期注解类型时,@IdleTimeoutExpiration@TimeToLiveExpiration优先于通用@Expiration注解,如前面的示例所示。@IdleTimeoutExpiration@TimeToLiveExpiration都不会覆盖对方。相反,当配置不同的区域条目过期策略(如 TTL 和 TTI)时,它们会互相补充。

所有基于@Expiration的注解仅适用于区域条目值。Spring Data for Apache Geode 的过期注解支持不涵盖区域的过期。但是,Apache Geode 和 Spring Data for Apache Geode 允许您使用 SDG XML 命名空间设置区域过期,如下所示

<gfe:*-region id="Example" persistent="false">
  <gfe:region-ttl timeout="600" action="DESTROY"/>
  <gfe:region-tti timeout="300" action="INVALIDATE"/>
</gfe:*-region>

Spring Data for Apache Geode 的@Expiration注解支持是使用 Apache Geode 的CustomExpiry接口实现的。有关更多详细信息,请参阅 Apache Geode 文档中的配置数据过期部分。

Spring Data for Apache Geode 的AnnotationBasedExpiration类(和CustomExpiry实现)负责处理 SDG @Expiration注解,并在请求时为区域条目过期适当地应用过期策略配置。

要使用 Spring Data for Apache Geode 配置特定的 Apache Geode 区域以适当地将过期策略应用于使用基于@Expiration的注解注释的应用程序域对象,您必须

  1. 在 Spring 的ApplicationContext中定义一个类型为AnnotationBasedExpiration的 bean,使用适当的构造函数或其中一个便捷的工厂方法。在为特定过期类型配置过期时,例如空闲超时(TTI)或生存时间(TTL),您应该使用AnnotationBasedExpiration类中的其中一个工厂方法,如下所示

    <bean id="ttlExpiration" class="org.springframework.data.gemfire.expiration.AnnotationBasedExpiration"
          factory-method="forTimeToLive"/>
    
    <gfe:partitioned-region id="Example" persistent="false">
        <gfe:custom-entry-ttl ref="ttlExpiration"/>
    </gfe:partitioned-region>

    要改为配置空闲超时(TTI)过期,请使用forIdleTimeout工厂方法以及<gfe:custom-entry-tti ref="ttiExpiration"/>元素来设置 TTI。

  2. (可选)使用 Spring Data for Apache Geode 的@Expiration注解(@Expiration@IdleTimeoutExpiration@TimeToLiveExpiration)注释存储在区域中的应用程序域对象,这些对象具有过期策略和自定义设置。

  3. (可选) 在某些情况下,特定应用程序域对象根本没有使用 Spring Data for Apache Geode 的 `@Expiration` 注解进行注释,但 Apache Geode Region 被配置为使用 SDG 的自定义 `AnnotationBasedExpiration` 类来确定存储在 Region 中的对象的过期策略和设置,您可以通过以下步骤在 `AnnotationBasedExpiration` bean 上设置“默认”过期属性

<bean id="defaultExpirationAttributes" class="org.apache.geode.cache.ExpirationAttributes">
    <constructor-arg value="600"/>
    <constructor-arg value="#{T(org.apache.geode.cache.ExpirationAction).DESTROY}"/>
</bean>

<bean id="ttiExpiration" class="org.springframework.data.gemfire.expiration.AnnotationBasedExpiration"
      factory-method="forIdleTimeout">
    <constructor-arg ref="defaultExpirationAttributes"/>
</bean>

<gfe:partitioned-region id="Example" persistent="false">
    <gfe:custom-entry-tti ref="ttiExpiration"/>
</gfe:partitioned-region>

您可能已经注意到,Spring Data for Apache Geode 的 `@Expiration` 注解使用 `String` 作为属性类型,而不是更合适的强类型,例如,`int` 用于 'timeout',而 SDG 的 `ExpirationActionType` 用于 'action'。为什么是这样呢?

好吧,让我们看看 Spring Data for Apache Geode 的另一个功能,利用 Spring 的核心基础设施来实现配置便利性:属性占位符和 Spring 表达式语言 (SpEL) 表达式。

例如,开发人员可以使用 `@Expiration` 注解属性中的属性占位符来指定过期 'timeout' 和 'action',如下面的示例所示

@TimeToLiveExpiration(timeout = "${geode.region.entry.expiration.ttl.timeout}"
    action = "${geode.region.entry.expiration.ttl.action}")
public class ExampleApplicationDomainObject {
  ...
}

然后,在您的 Spring XML 配置或 JavaConfig 中,您可以声明以下 bean

<util:properties id="expirationSettings">
  <prop key="geode.region.entry.expiration.ttl.timeout">600</prop>
  <prop key="geode.region.entry.expiration.ttl.action">INVALIDATE</prop>
  ...
</util:properties>

<context:property-placeholder properties-ref="expirationProperties"/>

这在多个应用程序域对象可能共享类似的过期策略以及您希望将配置外部化时都非常方便。

但是,您可能希望通过运行系统的状态来确定更动态的过期配置。这就是 SpEL 的强大功能发挥作用的地方,实际上也是推荐的方法。您不仅可以引用 Spring 容器中的 bean 并访问 bean 属性、调用方法等,而且过期 'timeout' 和 'action' 的值可以是强类型的。请考虑以下示例(它基于前面的示例)

<util:properties id="expirationSettings">
  <prop key="geode.region.entry.expiration.ttl.timeout">600</prop>
  <prop key="geode.region.entry.expiration.ttl.action">#{T(org.springframework.data.gemfire.expiration.ExpirationActionType).DESTROY}</prop>
  <prop key="geode.region.entry.expiration.tti.action">#{T(org.apache.geode.cache.ExpirationAction).INVALIDATE}</prop>
  ...
</util:properties>

<context:property-placeholder properties-ref="expirationProperties"/>

然后,在您的应用程序域对象上,您可以定义一个超时和一个操作,如下所示

@TimeToLiveExpiration(timeout = "@expirationSettings['geode.region.entry.expiration.ttl.timeout']"
    action = "@expirationSetting['geode.region.entry.expiration.ttl.action']")
public class ExampleApplicationDomainObject {
  ...
}

您可以想象 'expirationSettings' bean 可以是一个比 `java.util.Properties` 的简单实例更有趣和有用的对象。在前面的示例中,`properties` 元素(`expirationSettings`)使用 SpEL 将操作值基于实际的 `ExpirationAction` 枚举类型,如果枚举类型发生变化,则会迅速导致识别出的错误。

例如,所有这些都在 Spring Data for Apache Geode 测试套件中进行了演示和测试。有关更多详细信息,请参阅 源代码

5.5.10. 数据持久化

区域可以是持久化的。Apache Geode 确保您放入配置为持久化的区域中的所有数据都以可恢复的方式写入磁盘,以便您下次重新创建区域时可以恢复数据。这样做可以让数据在机器或进程故障后,甚至在 Apache Geode 数据节点正常关闭并随后重新启动后恢复。

要使用 Spring Data for Apache Geode 启用持久化,请在任何 <*-region> 元素上将 persistent 属性设置为 true,如下例所示

<gfe:partitioned-region id="examplePersitentPartitionRegion" persistent="true"/>

也可以通过设置 data-policy 属性来配置持久化。为此,请将属性的值设置为 Apache Geode 的 DataPolicy 设置 之一,如下例所示

<gfe:partitioned-region id="anotherExamplePersistentPartitionRegion" data-policy="PERSISTENT_PARTITION"/>

DataPolicy 必须与区域类型匹配,并且如果也显式设置了 persistent 属性,则还必须与该属性一致。如果将 persistent 属性设置为 false,但指定了持久性 DataPolicy(例如 PERSISTENT_REPLICATEPERSISTENT_PARTITION),则会抛出初始化异常。

为了在持久化区域时获得最大效率,您应该通过 disk-store 元素配置存储。DiskStore 通过使用 disk-store-ref 属性进行引用。此外,区域可以同步或异步执行磁盘写入。以下示例显示了一个同步 DiskStore

<gfe:partitioned-region id="yetAnotherExamplePersistentPartitionRegion" persistent="true"
    disk-store-ref="myDiskStore" disk-synchronous="true"/>

这将在 配置 DiskStore 中进一步讨论。

5.5.11. 订阅策略

Apache Geode 允许配置 点对点 (P2P) 事件消息传递 以控制区域接收的条目事件。Spring Data for Apache Geode 提供了 <gfe:subscription/> 子元素,用于在 REPLICATEPARTITION 区域上将订阅策略设置为 ALLCACHE_CONTENT。以下示例显示了一个区域,其订阅策略设置为 CACHE_CONTENT

<gfe:partitioned-region id="examplePartitionRegionWithCustomSubscription">
  <gfe:subscription type="CACHE_CONTENT"/>
</gfe:partitioned-region>

5.5.12. 本地区域

Spring Data for Apache Geode 提供了一个专门的 local-region 元素来创建本地区域。顾名思义,本地区域是独立的,这意味着它们不与任何其他分布式系统成员共享数据。除此之外,所有常见的区域配置选项都适用。

以下示例显示了一个最小声明(同样,该示例依赖于 Spring Data for Apache Geode XML 命名空间命名约定来连接缓存)

<gfe:local-region id="exampleLocalRegion"/>

在前面的示例中,将创建一个本地区域(如果不存在同名区域)。区域的名称与 bean ID(exampleLocalRegion)相同,并且该 bean 假设存在名为 gemfireCache 的 Apache Geode 缓存。

5.5.13. 复制区域

REPLICATE 区域或“副本”是常见的区域类型之一。简而言之,当区域配置为 REPLICATE 时,每个托管该区域的成员都会在本地存储该区域条目的副本。对 REPLICATE 区域的任何更新都会分发到该区域的所有副本。当创建副本时,它会经历一个初始化阶段,在此阶段它会发现其他副本并自动复制所有条目。当一个副本正在初始化时,您仍然可以继续使用其他副本。

所有常见的配置选项都可用于 REPLICATE 区域。Spring Data for Apache Geode 提供了一个 replicated-region 元素。以下示例展示了一个最小的声明

<gfe:replicated-region id="exampleReplica"/>

有关更多详细信息,请参阅 Apache Geode 的文档 分布式和复制区域

5.5.14. 分区区域

Spring Data for Apache Geode XML 命名空间也支持 PARTITION 区域。

引用 Apache Geode 文档

“分区区域是指数据在托管该区域的同级服务器之间进行划分,以便每个同级服务器存储数据的子集的区域。使用分区区域时,应用程序会看到一个逻辑视图,该视图看起来像一个包含区域中所有数据的单个映射。对该映射的读或写操作会透明地路由到托管该操作目标条目的同级服务器。Apache Geode 将哈希码域划分为桶。每个桶都分配给一个特定的同级服务器,但可以随时重新分配到另一个同级服务器,以提高整个集群的资源利用率。”

PARTITION 区域是通过使用 partitioned-region 元素创建的。它的配置选项类似于 replicated-region,但增加了特定于分区的特性,例如冗余副本的数量、总最大内存、桶的数量、分区解析器等等。

以下示例展示了如何设置具有两个冗余副本的 PARTITION 区域

<gfe:partitioned-region id="examplePartitionRegion" copies="2" total-buckets="17">
  <gfe:partition-resolver>
    <bean class="example.PartitionResolver"/>
  </gfe:partition-resolver>
</gfe:partitioned-region>

有关更多详细信息,请参阅 Apache Geode 的文档 分区区域

分区区域属性

下表提供了特定于PARTITION区域的配置选项的快速概述。这些选项是除了前面描述的通用区域配置选项之外的。

表 3. 分区区域属性
名称 描述

副本

0..4

每个分区的高可用性副本数量。默认情况下,不创建副本,这意味着没有冗余。每个副本都提供了额外的备份,但需要额外的存储空间。

与之共置

有效的区域名称

与新创建的PARTITION区域共置的PARTITION区域的名称。

本地最大内存

正整数

区域在**此**进程中使用的最大内存量(以兆字节为单位)。

总最大内存

任何整数值

区域在**所有**进程中使用的最大内存量(以兆字节为单位)。

分区监听器

bean 名称

此区域用于处理分区事件的PartitionListener的名称。

分区解析器

bean 名称

此区域用于自定义分区的PartitionResolver的名称。

恢复延迟

任何长整数值

现有成员在另一个成员崩溃后等待满足冗余的延迟(以毫秒为单位)。-1(默认值)表示在故障后不会恢复冗余。

启动恢复延迟

任何长整数值

新成员等待满足冗余的延迟(以毫秒为单位)。-1 表示添加新成员不会触发冗余恢复。默认情况下,在添加新成员时立即恢复冗余。

5.5.15. 客户端区域

Apache Geode 支持各种部署拓扑来管理和分发数据。Apache Geode 拓扑主题超出了本文档的范围。但是,为了快速回顾,Apache Geode 支持的拓扑可以分为:点对点 (p2p)、客户端-服务器和广域网 (WAN)。在最后两种配置中,通常声明连接到缓存服务器的客户端区域。

Spring Data for Apache Geode 为每种配置提供了专门的支持,通过其 client-cache 元素:client-regionpool。顾名思义,client-region 定义了一个客户端 Region,而 pool 定义了一个连接池,用于各种客户端 Region 使用和共享。

以下示例展示了一个典型的客户端 Region 配置

<bean id="myListener" class="example.CacheListener"/>

<!-- client Region using the default SDG gemfirePool Pool -->
<gfe:client-region id="Example">
  <gfe:cache-listener ref="myListener"/>
</gfe:client-region>

<!-- client Region using its own dedicated Pool -->
<gfe:client-region id="AnotherExample" pool-name="myPool">
  <gfe:cache-listener ref="myListener"/>
</gfe:client-region>

<!-- Pool definition -->
<gfe:pool id="myPool" subscription-enabled="true">
  <gfe:locator host="remoteHost" port="12345"/>
</gfe:pool>

与其他 Region 类型一样,client-region 也支持 CacheListener 实例以及 CacheLoaderCacheWriter。它还需要一个连接 Pool 来连接到一组 Locator 或服务器。每个客户端 Region 可以拥有自己的 Pool,也可以共享同一个 Pool。如果没有指定 Pool,则将使用 "DEFAULT" Pool

在前面的示例中,Pool 是使用 Locator 配置的。Locator 是一个独立的进程,用于在分布式系统中发现缓存服务器和对等数据成员,建议在生产系统中使用。也可以使用 server 元素将 Pool 配置为直接连接到一个或多个缓存服务器。

有关在客户端上设置选项(尤其是 Pool 上设置选项)的完整列表,请参阅 Spring Data for Apache Geode 架构(“Spring Data for Apache Geode 架构”)和 Apache Geode 的 客户端-服务器配置 文档。

客户端兴趣

为了最大程度地减少网络流量,每个客户端可以单独定义自己的“兴趣”策略,指示 Apache Geode 它实际需要的数据。在 Spring Data for Apache Geode 中,可以为每个客户端 Region 单独定义“兴趣”。支持基于键和基于正则表达式的兴趣类型。

以下示例展示了基于键和基于正则表达式的 interest 类型

<gfe:client-region id="Example" pool-name="myPool">
    <gfe:key-interest durable="true" result-policy="KEYS">
        <bean id="key" class="java.lang.String">
             <constructor-arg value="someKey"/>
        </bean>
    </gfe:key-interest>
    <gfe:regex-interest pattern=".*" receive-values="false"/>
</gfe:client-region>

特殊键 ALL_KEYS 表示为所有键注册“兴趣”。可以使用正则表达式 ".\*" 实现相同的效果。

<gfe:*-interest> 键和正则表达式元素支持三个属性:durablereceive-valuesresult-policy

durable 指示当客户端连接到集群中的一个或多个服务器时为客户端创建的“兴趣”策略和订阅队列是否在客户端会话之间维护。如果客户端断开连接并重新连接,则在客户端断开连接时,服务器上为客户端维护一个 durable 订阅队列。当客户端重新连接时,客户端会收到客户端与集群中的服务器断开连接期间发生的任何事件。

对于客户端中定义的每个已“启用”订阅的连接池(Pool),集群中的服务器都会维护一个订阅队列。订阅队列用于存储(并可能合并)发送到客户端的事件。如果订阅队列是持久的,它会在客户端会话(即连接)之间持续存在,可能持续到指定的超时时间。如果客户端在给定时间范围内没有返回,则会销毁客户端池订阅队列,以减少集群中服务器的资源消耗。如果订阅队列不是durable,则在客户端断开连接时立即销毁。您需要决定您的客户端是否应该接收断开连接期间发生的事件,或者是否只需要接收重新连接后的最新事件。

receive-values 属性指示是否接收创建和更新事件的条目值。如果为true,则接收值。如果为false,则只接收失效事件。

最后,result-policy 是一个枚举,包含:KEYSKEYS_VALUENONE。默认值为 KEYS_VALUESresult-policy 控制客户端首次连接时初始化本地缓存的初始转储,本质上是使用与兴趣策略匹配的所有条目的事件来为客户端播种。

正如前面提到的,如果没有在Pool上启用订阅,客户端侧的兴趣注册不会有什么作用。事实上,在没有启用订阅的情况下尝试兴趣注册是错误的。以下示例展示了如何进行操作。

<gfe:pool ... subscription-enabled="true">
  ...
</gfe:pool>

除了subscription-enabled,您还可以设置subscription-ack-intervalsubscription-message-tracking-timeoutsubscription-redundancysubscription-redundancy 用于控制集群中的服务器应该维护多少个订阅队列副本。如果冗余度大于 1,并且“主”订阅队列(即服务器)出现故障,那么“备用”订阅队列将接管,从而防止客户端在 HA 场景中丢失事件。

除了Pool设置之外,服务器端的区域使用一个额外的属性enable-subscription-conflation来控制发送到客户端的事件的合并。这也有助于进一步减少网络流量,并且在应用程序只关心条目的最新值的情况下非常有用。但是,当应用程序保留发生的事件的时间序列时,合并会阻碍这种用例。默认值为false。以下示例展示了服务器上的区域配置,客户端包含一个对应的客户端[CACHING_]PROXY区域,该区域对该服务器区域中的键感兴趣。

<gfe:partitioned-region name="ServerSideRegion" enable-subscription-conflation="true">
  ...
</gfe:partitioned-region>

要控制在客户端与集群中的服务器断开连接后,“持久”订阅队列维护的时间量(以秒为单位),请在<gfe:client-cache>元素上设置durable-client-timeout属性,如下所示

<gfe:client-cache durable-client-timeout="600">
  ...
</gfe:client-cache>

关于客户端兴趣的工作原理和功能的完整深入讨论超出了本文档的范围。

有关更多详细信息,请参阅 Apache Geode 的文档,网址为 客户端到服务器事件分发

5.5.16. JSON 支持

Apache Geode 支持在区域中缓存 JSON 文档,以及使用 Apache Geode OQL(对象查询语言)查询存储的 JSON 文档的能力。JSON 文档在内部存储为 PdxInstance 类型,通过使用 JSONFormatter 类来执行与 JSON 文档(作为String)之间的转换。

Spring Data for Apache Geode 提供了<gfe-data:json-region-autoproxy/>元素来启用一个 AOP 组件来建议适当的代理区域操作,这有效地封装了JSONFormatter,从而让您的应用程序直接使用 JSON 字符串。

此外,写入 JSON 配置区域的 Java 对象会自动使用 Jackson 的ObjectMapper转换为 JSON。当这些值被读回时,它们将作为 JSON 字符串返回。

默认情况下,<gfe-data:json-region-autoproxy/>对所有区域执行转换。要将此功能应用于选定的区域,请在region-refs属性中提供区域 bean ID 的逗号分隔列表。其他属性包括pretty-print标志(默认为false)和convert-returned-collections

此外,默认情况下,getAll()values()区域操作的结果将针对配置的区域进行转换。这是通过在本地内存中创建并行数据结构来完成的。这可能会对大型集合造成巨大的开销,因此如果您想禁用这些区域操作的自动转换,请将convert-returned-collections设置为false

某些区域操作(特别是那些使用 Apache Geode 专有的Region.Entry的操作,例如:entries(boolean)entrySet(boolean)getEntry()类型)不是 AOP 建议的目标。此外,entrySet()方法(它返回一个Set<java.util.Map.Entry<?, ?>>)也不受影响。

以下示例配置展示了如何设置pretty-printconvert-returned-collections属性

<gfe-data:json-region-autoproxy region-refs="myJsonRegion" pretty-print="true" convert-returned-collections="false"/>

此功能也与GemfireTemplate操作无缝衔接,前提是模板被声明为 Spring bean。目前,原生QueryService操作不支持。

5.6. 配置索引

Apache Geode 允许在 Region 数据上创建索引(有时也称为索引),以提高 OQL(对象查询语言)查询的性能。

在 Spring Data for Apache Geode 中,索引使用index元素声明,如下例所示

<gfe:index id="myIndex" expression="someField" from="/SomeRegion" type="HASH"/>

在 Spring Data for Apache Geode 的 XML 模式(也称为 SDG XML 命名空间)中,index bean 声明不像 Apache Geode 的原生cache.xml那样绑定到 Region。相反,它们是类似于<gfe:cache>元素的顶级元素。这使您可以在任何 Region 上声明任意数量的索引,无论它们是新创建的还是已经存在的——这比 Apache Geode 的原生cache.xml格式有了很大的改进。

Index必须有一个名称。您可以使用name属性为Index指定一个显式名称。否则,index bean 定义的 bean 名称(即id属性的值)将用作Index名称。

expressionfrom子句构成了Index的主要组成部分,它们标识要索引的数据(即from子句中标识的 Region),以及用于索引数据的标准(即expression)。expression应该基于应用程序定义的 OQL 查询谓词中使用的应用程序域对象字段,这些查询用于查询和查找存储在 Region 中的对象。

考虑以下示例,它具有lastName属性

@Region("Customers")
class Customer {

  @Id
  Long id;

  String lastName;
  String firstName;

  ...
}

现在考虑以下示例,它具有一个应用程序定义的 SDG 存储库来查询Customer对象

interface CustomerRepository extends GemfireRepository<Customer, Long> {

  Customer findByLastName(String lastName);

  ...
}

SDG 存储库查找器/查询方法导致生成并运行以下 OQL 语句

SELECT * FROM /Customers c WHERE c.lastName = '$1'

因此,您可能希望创建一个具有类似于以下语句的Index

<gfe:index id="myIndex" name="CustomersLastNameIndex" expression="lastName" from="/Customers" type="HASH"/>

from子句必须引用一个有效的现有 Region,它是Index如何应用于 Region 的方式。这并非 Spring Data for Apache Geode 特有的。它是 Apache Geode 的一项功能。

Indextype 属性可以是 Spring Data for Apache Geode 为 IndexType 枚举定义的三个枚举值之一:FUNCTIONALHASHPRIMARY_KEY

每个枚举值对应于 QueryServicecreate[|Key|Hash]Index 方法,这些方法在实际创建(或“定义” - 您可以在下一节中找到有关“定义”索引的更多信息)Index 时被调用。例如,如果 IndexTypePRIMARY_KEY,则将调用 QueryService.createKeyIndex(..) 来创建一个 KEY Index

默认值为 FUNCTIONAL,并导致调用 QueryService.createIndex(..) 方法之一。有关完整选项集,请参阅 Spring Data for Apache Geode XML 架构。

有关 Apache Geode 中索引的更多信息,请参阅 Apache Geode 用户指南中的“使用索引”。

5.6.1. 定义索引

除了在 Spring 容器初始化时,Spring Data for Apache Geode 处理 Index bean 定义时预先创建索引外,您还可以使用 define 属性在创建索引之前定义所有应用程序索引,如下所示

<gfe:index id="myDefinedIndex" expression="someField" from="/SomeRegion" define="true"/>

define 设置为 true(默认值为 false)时,它不会立即创建 Index。所有“已定义”的索引将在 Spring ApplicationContext “刷新”时(或者换句话说,当 Spring 容器发布 ContextRefreshedEvent 时)一次性创建。Spring Data for Apache Geode 将自己注册为一个 ApplicationListener,监听 ContextRefreshedEvent。当触发时,Spring Data for Apache Geode 会调用 QueryService.createDefinedIndexes().

定义索引并一次性创建它们可以提高创建索引时的速度和效率。

有关更多详细信息,请参阅“一次创建多个索引”。

5.6.2. IgnoreIfExistsOverride

两个 Spring Data for Apache Geode Index 配置选项值得特别提及:ignoreIfExistsoverride

这些选项分别对应于 Spring Data for Apache Geode 的 XML 命名空间中 <gfe:index> 元素的 ignore-if-existsoverride 属性。

在使用这两个选项之前,请确保您完全理解自己在做什么。这些选项可能会影响应用程序在运行时的性能和资源(例如内存)消耗。因此,这两个选项在 SDG 中默认情况下都是禁用的(设置为 false)。
这些选项仅在 Spring Data for Apache Geode 中可用,并且存在于解决 Apache Geode 的已知限制。Apache Geode 没有等效的选项或功能。

每个选项的行为都存在显著差异,并且完全取决于抛出的 Apache Geode Index 异常类型。这也意味着,如果未抛出 Apache Geode Index 类型异常,则这两个选项均无效。这些选项旨在专门处理 Apache Geode IndexExistsExceptionIndexNameConflictException 实例,这些实例可能由于各种原因(有时很模糊)而发生。这些异常有以下原因:

  • 当尝试创建 Index 时,如果存在另一个具有相同定义但名称不同的 Index,则会抛出 IndexExistsException

  • 当尝试创建 Index 时,如果存在另一个具有相同名称但定义可能不同的 Index,则会抛出 IndexNameConflictException

Spring Data for Apache Geode 的默认行为是始终快速失败。因此,默认情况下不会“处理”任何 Index 异常。这些 Index 异常将包装在 SDG GemfireIndexException 中并重新抛出。如果您希望 Spring Data for Apache Geode 为您处理它们,可以将这两个 Index bean 定义选项设置为 true

IgnoreIfExists 始终优先于 Override,主要是因为它使用的资源更少,因为它在两种异常情况下都只是返回“现有”的 Index

IgnoreIfExists 行为

当抛出 IndexExistsException 并且 ignoreIfExists 设置为 true(或 <gfe:index ignore-if-exists="true">)时,将简单地忽略此 index bean 定义或声明本来要创建的 Index,并返回现有的 Index

返回现有的 Index 几乎没有影响,因为 index bean 定义是相同的,这是由 Apache Geode 本身决定的,而不是 SDG。

但是,这也意味着从 Apache Geode 的角度来看,您的 index bean 定义或声明中指定的“名称”的 Index 实际上不存在(即,使用 QueryService.getIndexes())。因此,在编写使用查询提示的 OQL 查询语句时,您应该小心,尤其是引用被忽略的应用程序 Index 的查询提示。这些查询提示需要更改。

当抛出 IndexNameConflictExceptionignoreIfExists 设置为 true(或 <gfe:index ignore-if-exists="true">)时,将忽略由该 index bean 定义或声明创建的 Index,并且会再次返回“现有”Index,就像抛出 IndexExistsException 时一样。

但是,当抛出 IndexNameConflictException 时,返回现有 Index 并忽略应用程序对 Index 的定义存在更大的风险。对于 IndexNameConflictException,虽然冲突索引的名称相同,但定义可能不同。这种情况可能会对特定于应用程序的 OQL 查询产生影响,在这些查询中,您会假设索引是专门针对应用程序数据访问模式和查询定义的。但是,如果同名索引的定义不同,则情况可能并非如此。因此,您应该验证您的 Index 名称。

SDG 会尽力在被忽略的 Index 的定义与其现有 Index 的定义有很大差异时通知用户。但是,为了让 SDG 完成此操作,它必须能够找到现有 Index,这可以通过使用 Apache Geode API(唯一可用的方法)来查找。
Override 行为

当抛出 IndexExistsExceptionoverride 设置为 true(或 <gfe:index override="true">)时,Index 将被有效地重命名。请记住,当存在多个具有相同定义但不同名称的索引时,会抛出 IndexExistsExceptions

Spring Data for Apache Geode 只能通过使用 Apache Geode 的 API 来实现这一点,方法是首先删除现有 Index,然后使用新名称重新创建 Index。删除或随后的创建调用都可能失败。无法以原子方式执行这两个操作,并在任何一个操作失败时回滚此联合操作。

但是,如果成功,则您将遇到与 ignoreIfExists 选项相同的问题。任何使用查询提示并按名称引用旧 Index 的现有 OQL 查询语句都必须更改。

当抛出 IndexNameConflictExceptionoverride 设置为 true(或 <gfe:index override="true">)时,现有 Index 可能被重新定义。我们说“可能”,因为当抛出 IndexNameConflictException 时,同名现有 Index 可能具有完全相同的定义和名称。

如果是这样,SDG 很聪明,即使在 `override` 时也会原样返回现有的 `Index`。这种行为没有问题,因为名称和定义完全相同。当然,SDG 只有在能够找到现有的 `Index` 时才能做到这一点,这取决于 Apache Geode 的 API。如果找不到,则不会发生任何事情,并且会抛出一个包装了 `IndexNameConflictException` 的 SDG `GemfireIndexException`。

但是,当现有 `Index` 的定义不同时,SDG 会尝试使用 `index` bean 定义中指定的 `Index` 定义重新创建 `Index`。请确保这是您想要的,并确保 `index` bean 定义符合您的预期和应用程序要求。

IndexNameConflictExceptions 实际上是如何发生的?

抛出 `IndexExistsExceptions` 可能并不罕见,尤其是在使用多个配置源来配置 Apache Geode 时(Spring Data for Apache Geode、Apache Geode Cluster Config、Apache Geode 原生 `cache.xml`、API 等等)。您应该绝对优先选择一种配置方法并坚持使用它。

但是,什么时候会抛出 `IndexNameConflictException` 呢?

一个特殊情况是在 `PARTITION` Region (PR) 上定义的 `Index`。当在 `PARTITION` Region (例如,`X`) 上定义 `Index` 时,Apache Geode 会将 `Index` 定义(和名称)分发到集群中也托管相同 `PARTITION` Region (即,“X”) 的其他对等成员。这种 `Index` 定义的分发以及对等成员随后创建此 `Index` 是根据需要进行的(即,由托管相同 PR 的对等成员进行),并且是异步执行的。

在此期间,Apache Geode 可能无法识别这些挂起的 PR `Index`,例如,使用 QueryService.getIndexes() 以及 QueryService.getIndexes(:Region),甚至使用 QueryService.getIndex(:Region, indexName:String)

因此,SDG 或其他 Apache Geode 缓存客户端应用程序(不涉及 Spring)唯一确定的方法是尝试创建 `Index`。如果它因 `IndexNameConflictException` 甚至 `IndexExistsException` 而失败,则应用程序知道存在问题。这是因为 `QueryService` `Index` 创建会等待挂起的 `Index` 定义,而其他 Apache Geode API 调用则不会。

无论如何,SDG 会尽力尝试通知您发生了什么或正在发生的事情,并告知您纠正措施。鉴于所有 Apache Geode `QueryService.createIndex(..) `方法都是同步的阻塞操作,因此在抛出任何一种索引类型异常后,Apache Geode 的状态应保持一致且可访问。因此,SDG 可以根据您的配置检查系统状态并采取相应措施。

在所有其他情况下,SDG 采用快速失败策略。

5.7. 配置 DiskStore

Spring Data for Apache Geode 通过 `disk-store` 元素支持 `DiskStore` 配置和创建,如下例所示

<gfe:disk-store id="Example" auto-compact="true" max-oplog-size="10"
                queue-size="50" time-interval="9999">
    <gfe:disk-dir location="/disk/location/one" max-size="20"/>
    <gfe:disk-dir location="/disk/location/two" max-size="20"/>
</gfe:disk-store>

`DiskStore` 实例由区域用于文件系统持久备份和驱逐条目的溢出,以及 WAN 网关的持久备份。多个 Apache Geode 组件可以共享同一个 `DiskStore`。此外,可以为单个 `DiskStore` 定义多个文件系统目录,如前面的示例所示。

有关 `DiskStore` 实例的持久性和溢出以及配置选项的完整说明,请参阅 Apache Geode 文档 持久性和溢出

5.8. 配置快照服务

Spring Data for Apache Geode 通过使用 Apache Geode 的快照服务 支持缓存和区域快照。开箱即用的快照服务支持提供了一些方便的功能,简化了 Apache Geode 的 缓存区域 快照服务 API 的使用。

正如 Apache Geode 文档 所解释的那样,快照允许您保存缓存数据,并在以后重新加载,这对于在环境之间移动数据非常有用,例如从生产环境移动到暂存或测试环境,以便在受控环境中重现与数据相关的问题。您可以将 Spring Data for Apache Geode 的快照服务支持与 Spring 的 bean 定义配置文件 相结合,根据需要加载特定于环境的快照数据。

Spring Data for Apache Geode 对 Apache Geode 的快照服务的支持从 `` XML 命名空间中的 `` 元素开始。

例如,您可以使用几个快照导入和一个数据导出定义来定义要加载和保存的缓存范围快照,如下所示

<gfe-data:snapshot-service id="gemfireCacheSnapshotService">
  <gfe-data:snapshot-import location="/absolute/filesystem/path/to/import/fileOne.snapshot"/>
  <gfe-data:snapshot-import location="relative/filesystem/path/to/import/fileTwo.snapshot"/>
  <gfe-data:snapshot-export
      location="/absolute/or/relative/filesystem/path/to/export/directory"/>
</gfe-data:snapshot-service>

您可以根据需要定义任意数量的导入和导出。您可以只定义导入或只定义导出。文件位置和目录路径可以是绝对路径或相对于 Spring Data for Apache Geode 应用程序的路径,即 JVM 进程的工作目录。

前面的示例非常简单,在这种情况下定义的快照服务引用了 Apache Geode 缓存实例,其默认名称为 `gemfireCache`(如 配置缓存 中所述)。如果您将缓存 bean 定义命名为除默认名称以外的名称,则可以使用 `cache-ref` 属性按名称引用缓存 bean,如下所示

<gfe:cache id="myCache"/>
...
<gfe-data:snapshot-service id="mySnapshotService" cache-ref="myCache">
  ...
</gfe-data:snapshot-service>

您还可以通过指定 `region-ref` 属性为特定区域定义快照服务,如下所示

<gfe:partitioned-region id="Example" persistent="false" .../>
...
<gfe-data:snapshot-service id="gemfireCacheRegionSnapshotService" region-ref="Example">
  <gfe-data:snapshot-import location="relative/path/to/import/example.snapshot/>
  <gfe-data:snapshot-export location="/absolute/path/to/export/example.snapshot/>
</gfe-data:snapshot-service>

当指定 `region-ref` 属性时,Spring Data for Apache Geode 的 `SnapshotServiceFactoryBean` 会将 `region-ref` 属性值解析为 Spring 容器中定义的区域 bean,并创建一个 RegionSnapshotService。快照导入和导出定义的功能相同。但是,`location` 必须引用导出文件。

Apache Geode 对导入的快照文件实际上在被引用之前就存在非常严格。对于导出,Apache Geode 会创建快照文件。如果要导出的快照文件已存在,则会覆盖数据。
Spring Data for Apache Geode 在 `` 元素上包含一个 `suppress-import-on-init` 属性,以阻止配置的快照服务在初始化时尝试将数据导入缓存或区域。这样做很有用,例如,当从一个区域导出的数据用于为另一个区域的导入提供数据时。

5.8.1. 快照位置

使用基于缓存的快照服务(即 CacheSnapshotService),您通常会向其传递一个包含所有要加载的快照文件的目录,而不是单个快照文件,因为 `CacheSnapshotService` API 中的重载 load 方法所指示的那样。

当然,您可以使用重载的 `load(:File[], :SnapshotFormat, :SnapshotOptions)` 方法来指定要加载到 Apache Geode 缓存中的特定快照文件。

然而,Spring Data for Apache Geode 认识到,典型的开发人员工作流程可能是从一个环境中提取和导出数据到多个快照文件,将所有文件压缩成一个 zip 文件,然后方便地将该 zip 文件移动到另一个环境中进行导入。

因此,Spring Data for Apache Geode 允许您在导入基于 cache 的快照服务时指定一个 jar 或 zip 文件,如下所示

  <gfe-data:snapshot-service id="cacheBasedSnapshotService" cache-ref="gemfireCache">
    <gfe-data:snapshot-import location="/path/to/snapshots.zip"/>
  </gfe-data:snapshot-service>

Spring Data for Apache Geode 方便地提取提供的 zip 文件,并将其视为目录导入(加载)。

5.8.2. 快照过滤器

定义多个快照导入和导出真正的强大之处在于使用快照过滤器。快照过滤器实现 Apache Geode 的 SnapshotFilter 接口,用于过滤区域条目,以便在导入时包含在区域中,并在导出时包含在快照中。

Spring Data for Apache Geode 允许您在导入和导出时使用快照过滤器,方法是使用 filter-ref 属性或匿名嵌套 bean 定义,如下例所示

<gfe:cache/>

<gfe:partitioned-region id="Admins" persistent="false"/>
<gfe:partitioned-region id="Guests" persistent="false"/>

<bean id="activeUsersFilter" class="example.gemfire.snapshot.filter.ActiveUsersFilter/>

<gfe-data:snapshot-service id="adminsSnapshotService" region-ref="Admins">
  <gfe-data:snapshot-import location="/path/to/import/users.snapshot">
    <bean class="example.gemfire.snapshot.filter.AdminsFilter/>
  </gfe-data:snapshot-import>
  <gfe-data:snapshot-export location="/path/to/export/active/admins.snapshot" filter-ref="activeUsersFilter"/>
</gfe-data:snapshot-service>

<gfe-data:snapshot-service id="guestsSnapshotService" region-ref="Guests">
  <gfe-data:snapshot-import location="/path/to/import/users.snapshot">
    <bean class="example.gemfire.snapshot.filter.GuestsFilter/>
  </gfe-data:snapshot-import>
  <gfe-data:snapshot-export location="/path/to/export/active/guests.snapshot" filter-ref="activeUsersFilter"/>
</gfe-data:snapshot-service>

此外,您可以使用 ComposableSnapshotFilter 类来表达更复杂的快照过滤器。此类实现了 Apache Geode 的 SnapshotFilter 接口以及 组合 软件设计模式。

简而言之,组合 软件设计模式允许您组合多个相同类型的对象,并将聚合视为该对象类型的单个实例——这是一种强大而有用的抽象。

ComposableSnapshotFilter 具有两个工厂方法,andor。它们允许您分别使用 AND 和 OR 逻辑运算符逻辑地组合各个快照过滤器。工厂方法接受一个 SnapshotFilters 列表。

以下示例显示了 ComposableSnapshotFilter 的定义

<bean id="activeUsersSinceFilter" class="org.springframework.data.gemfire.snapshot.filter.ComposableSnapshotFilter"
      factory-method="and">
  <constructor-arg index="0">
    <list>
      <bean class="org.example.app.gemfire.snapshot.filter.ActiveUsersFilter"/>
      <bean class="org.example.app.gemfire.snapshot.filter.UsersSinceFilter"
            p:since="2015-01-01"/>
    </list>
  </constructor-arg>
</bean>

然后,您可以继续使用 oractivesUsersSinceFilter 与另一个过滤器组合,如下所示

<bean id="covertOrActiveUsersSinceFilter" class="org.springframework.data.gemfire.snapshot.filter.ComposableSnapshotFilter"
      factory-method="or">
  <constructor-arg index="0">
    <list>
      <ref bean="activeUsersSinceFilter"/>
      <bean class="example.gemfire.snapshot.filter.CovertUsersFilter"/>
    </list>
  </constructor-arg>
</bean>

5.8.3. 快照事件

默认情况下,Spring Data for Apache Geode 在启动时使用 Apache Geode 的快照服务来导入数据,在关闭时使用快照服务来导出数据。但是,您可能希望在 Spring 应用程序中触发周期性的基于事件的快照,用于导入或导出。

为此,Spring Data for Apache Geode 定义了两个额外的 Spring 应用程序事件,扩展了 Spring 的 ApplicationEvent 类,分别用于导入和导出:ImportSnapshotApplicationEventExportSnapshotApplicationEvent

这两个应用程序事件可以针对整个 Apache Geode 缓存或针对单个 Apache Geode 区域。这些类中的构造函数接受可选的区域路径名(例如 /Example)以及零个或多个 SnapshotMetadata 实例。

SnapshotMetadata 数组会覆盖由 <gfe-data:snapshot-import><gfe-data:snapshot-export> 子元素定义的快照元数据,这些子元素用于快照应用程序事件未明确提供 SnapshotMetadata 的情况。每个单独的 SnapshotMetadata 实例都可以定义自己的 locationfilters 属性。

在 Spring ApplicationContext 中定义的所有快照服务 Bean 都接收导入和导出快照应用程序事件。但是,只有匹配的快照服务 Bean 处理导入和导出事件。

基于区域的 [Import|Export]SnapshotApplicationEvent 匹配,如果定义的快照服务 Bean 是 RegionSnapshotService 并且其区域引用(由 region-ref 属性确定)与快照应用程序事件指定的区域路径名匹配。

基于缓存的 [Import|Export]SnapshotApplicationEvent(即没有区域路径名的快照应用程序事件)会触发所有快照服务 Bean(包括任何 RegionSnapshotService Bean)分别执行导入或导出。

您可以使用 Spring 的 ApplicationEventPublisher 接口从您的应用程序中触发导入和导出快照应用程序事件,如下所示

@Component
public class ExampleApplicationComponent {

  @Autowired
  private ApplicationEventPublisher eventPublisher;

  @Resource(name = "Example")
  private Region<?, ?> example;

  public void someMethod() {

    ...

    File dataSnapshot = new File(System.getProperty("user.dir"), "/path/to/export/data.snapshot");

    SnapshotFilter myFilter = ...;

    SnapshotMetadata exportSnapshotMetadata =
        new SnapshotMetadata(dataSnapshot, myFilter, null);

    ExportSnapshotApplicationEvent exportSnapshotEvent =
        new ExportSnapshotApplicationEvent(this, example.getFullPath(), exportSnapshotMetadata)

    eventPublisher.publishEvent(exportSnapshotEvent);

    ...
  }
}

在前面的示例中,只有 /Example 区域的快照服务 Bean 会接收并处理导出事件,将过滤后的“/Example”区域的数据保存到应用程序工作目录的子目录中的 data.snapshot 文件中。

使用 Spring 应用程序事件和消息传递子系统是保持应用程序松散耦合的好方法。您还可以使用 Spring 的 调度 服务定期触发快照应用程序事件。

5.9. 配置函数服务

Spring Data for Apache Geode 提供了 注释 支持来实现、注册和执行 Apache Geode 函数。

Spring Data for Apache Geode 还提供了 XML 命名空间支持来注册 Apache Geode 函数 以进行远程函数执行。

有关函数执行框架的更多信息,请参阅 Apache Geode 的 文档

Apache Geode 函数被声明为 Spring bean,并且必须实现 org.apache.geode.cache.execute.Function 接口或扩展 org.apache.geode.cache.execute.FunctionAdapter

命名空间使用熟悉的模式来声明函数,如下面的示例所示

<gfe:function-service>
  <gfe:function>
      <bean class="example.FunctionOne"/>
      <ref bean="function2"/>
  </gfe:function>
</gfe:function-service>

<bean id="function2" class="example.FunctionTwo"/>

5.10. 配置 WAN 网关

WAN 网关提供了一种跨地理位置同步 Apache Geode 分布式系统的方法。Spring Data for Apache Geode 提供了 XML 命名空间支持,用于配置 WAN 网关,如以下示例所示。

5.10.1. Apache Geode 7.0 中的 WAN 配置

在以下示例中,GatewaySenders 是为 PARTITION 区域配置的,方法是在区域中添加子元素(gateway-sendergateway-sender-ref)。GatewaySender 可以注册 EventFiltersTransportFilters

以下示例还展示了 AsyncEventQueue 的示例配置,该配置也必须自动连接到区域(未显示)

<gfe:partitioned-region id="region-with-inner-gateway-sender" >
    <gfe:gateway-sender remote-distributed-system-id="1">
        <gfe:event-filter>
	        <bean class="org.springframework.data.gemfire.example.SomeEventFilter"/>
        </gfe:event-filter>
        <gfe:transport-filter>
	        <bean class="org.springframework.data.gemfire.example.SomeTransportFilter"/>
        </gfe:transport-filter>
    </gfe:gateway-sender>
    <gfe:gateway-sender-ref bean="gateway-sender"/>
</gfe:partitioned-region>

<gfe:async-event-queue id="async-event-queue" batch-size="10" persistent="true" disk-store-ref="diskstore"
        maximum-queue-memory="50">
    <gfe:async-event-listener>
        <bean class="example.AsyncEventListener"/>
    </gfe:async-event-listener>
</gfe:async-event-queue>

<gfe:gateway-sender id="gateway-sender" remote-distributed-system-id="2">
    <gfe:event-filter>
        <ref bean="event-filter"/>
        <bean class="org.springframework.data.gemfire.example.SomeEventFilter"/>
    </gfe:event-filter>
    <gfe:transport-filter>
        <ref bean="transport-filter"/>
        <bean class="org.springframework.data.gemfire.example.SomeTransportFilter"/>
    </gfe:transport-filter>
</gfe:gateway-sender>

<bean id="event-filter" class="org.springframework.data.gemfire.example.AnotherEventFilter"/>
<bean id="transport-filter" class="org.springframework.data.gemfire.example.AnotherTransportFilter"/>

GatewaySender 的另一端是相应的 GatewayReceiver,用于接收网关事件。GatewayReceiver 也可以配置 EventFiltersTransportFilters,如下所示

<gfe:gateway-receiver id="gateway-receiver" start-port="12345" end-port="23456" bind-address="192.168.0.1">
    <gfe:transport-filter>
        <bean class="org.springframework.data.gemfire.example.SomeTransportFilter"/>
    </gfe:transport-filter>
</gfe:gateway-receiver>

有关所有配置选项的详细说明,请参阅 Apache Geode 文档

6. 使用注解将 Apache Geode 与 Spring 容器一起启动

Spring Data for Apache Geode (SDG) 2.0 引入了一种新的基于注解的配置模型,用于使用 Spring 容器配置和启动 Apache Geode。

在 Spring 上下文中引入基于注解的 Apache Geode 配置方法的主要动机是使 Spring 应用程序开发人员能够快速轻松地启动和运行

让我们开始吧!

如果您想更快地入门,请参考 快速入门 部分。

6.1. 简介

Apache Geode 以及 Spring Data for Apache Geode 提供了许多配置选项

此外,Apache Geode 和 Spring Data for Apache Geode 都支持不同的拓扑结构

所有这些配置选项和拓扑结构安排在设置和使用 Apache Geode 时可能会带来挑战。Spring Data for Apache Geode 基于注解的配置模型旨在简化拓扑结构等方面的配置。

基于注解的配置模型是使用 Spring Data for Apache Geode 的 XML 命名空间的基于 XML 的配置的替代方案。使用 XML,您可以使用 `gfe` XML 模式进行配置,并使用 `gfe-data` XML 模式进行数据访问。有关更多详细信息,请参见“使用 Spring 容器引导 Apache Geode”。

从 SDG 2.0 开始,基于注解的配置模型尚不支持 Apache Geode 的 WAN 组件和拓扑结构的配置。

与 Spring Boot 一样,Spring Data for Apache Geode 的基于注解的配置模型被设计为一种约定优于配置的方法,用于使用 Apache Geode。实际上,这种基于注解的配置模型的灵感来自 Spring Boot 以及其他几个 Spring 和 Spring Data 项目。

通过遵循约定,所有注解都为所有配置属性提供合理且明智的默认值。给定注解属性的默认值直接对应于 Apache Geode 中为相同配置属性提供的默认值。

目的是让您通过在 Spring `@Configuration` 或 `@SpringBootApplication` 类上声明相应的注解来启用 Apache Geode 功能或嵌入式服务,而无需不必要地配置大量属性来使用该功能或服务。

再次强调,快速入门快速轻松是主要目标。

但是,如果您需要自定义 Apache Geode 的配置元数据和行为,则可以选择这样做,Spring Data for Apache Geode 的基于注解的配置会默默地退后。您只需要指定要调整的配置属性。此外,正如我们将在本文档后面看到的那样,有几种方法可以使用注解来配置 Apache Geode 功能或嵌入式服务。

您可以在 `org.springframework.data.gemfire.config.annotation` 包中找到所有新的 SDG Java `Annotations`。

6.2. 使用 Spring 配置 Apache Geode 应用程序

与所有以在应用程序类上使用@SpringBootApplication注解开始的 Spring Boot 应用程序一样,Spring Boot 应用程序可以通过声明以下三个主要注解中的任何一个轻松地成为 Apache Geode 缓存应用程序。

  • @ClientCacheApplication

  • @PeerCacheApplication

  • @CacheServerApplication

这三个注解是 Spring 应用程序开发人员在使用 Apache Geode 时开始工作的起点。

为了实现这些注解背后的意图,您必须了解可以使用 Apache Geode 创建两种类型的缓存实例:客户端缓存或对等缓存。

您可以将 Spring Boot 应用程序配置为 Apache Geode 缓存客户端,使用ClientCache实例,该实例可以与用于管理应用程序数据的现有 Apache Geode 服务器集群通信。客户端-服务器拓扑是使用 Apache Geode 时最常见的系统架构,您可以通过使用@ClientCacheApplication注解您的 Spring Boot 应用程序,使其成为带有ClientCache实例的缓存客户端。

或者,Spring Boot 应用程序可以是 Apache Geode 集群的对等成员。也就是说,应用程序本身只是管理数据的服务器集群中的另一台服务器。当您使用@PeerCacheApplication注解您的应用程序类时,Spring Boot 应用程序会创建一个“嵌入式”的对等Cache实例。

扩展而言,对等缓存应用程序也可以充当CacheServer,允许缓存客户端连接并对服务器执行数据访问操作。这可以通过在应用程序类上使用@CacheServerApplication注解来实现,而不是使用@PeerCacheApplication,这将创建一个对等Cache实例以及允许缓存客户端连接的CacheServer

默认情况下,Apache Geode 服务器不一定是缓存服务器。也就是说,服务器不一定是为缓存客户端提供服务的,即使它是一个服务器。Apache Geode 服务器可以是集群的成员节点(数据节点),管理数据而不为任何客户端提供服务,而集群中的其他成员节点确实设置为在管理数据的同时为客户端提供服务。还可以将集群中的某些成员节点设置为非数据节点,称为 数据访问器,它们不存储数据,但充当代理以作为 CacheServers 为客户端提供服务。Apache Geode 支持许多不同的拓扑结构和集群安排,但不在本文档的讨论范围之内。

例如,如果您想创建一个 Spring Boot 缓存客户端应用程序,请从以下步骤开始

基于 Spring 的 Apache Geode ClientCache 应用程序
@SpringBootApplication
@ClientCacheApplication
class ClientApplication { .. }

或者,如果您想创建一个带有嵌入式成员节点 Cache 实例的 Spring Boot 应用程序,其中您的应用程序将是 Apache Geode 形成的集群(分布式系统)的服务器和成员节点,请从以下步骤开始

基于 Spring 的 Apache Geode 嵌入式成员节点 Cache 应用程序
@SpringBootApplication
@PeerCacheApplication
class ServerApplication { .. }

或者,您可以使用 @CacheServerApplication 注解代替 @PeerCacheApplication 来创建一个嵌入式成员节点 Cache 实例以及一个在 localhost 上运行的 CacheServer,监听默认的缓存服务器端口 40404,如下所示

基于 Spring 的 Apache Geode 嵌入式成员节点 Cache 应用程序,带有 CacheServer
@SpringBootApplication
@CacheServerApplication
class ServerApplication { .. }

6.3. 客户端/服务器应用程序详解

客户端可以有多种方式连接到 Apache Geode 集群中的服务器并与之通信。最常见且推荐的方法是使用 Apache Geode 定位器。

缓存客户端可以连接到 Apache Geode 集群中的一个或多个定位器,而不是直接连接到 CacheServer。与直接连接到 CacheServer 相比,使用定位器的优势在于定位器提供了有关客户端连接到的集群的元数据。这些元数据包括有关哪些服务器包含感兴趣的数据或哪些服务器负载最小的信息。与定位器一起使用的客户端 Pool 还提供了故障转移功能,以防 CacheServer 崩溃。通过在客户端 Pool 中启用 PARTITION 区域 (PR) 单跳功能,客户端将直接路由到包含客户端请求和需要的数据的服务器。
定位器也是集群中的对等成员。定位器实际上构成了 Apache Geode 节点集群的组成部分。也就是说,所有通过定位器连接的节点都是集群中的对等节点,新成员使用定位器加入集群并查找其他成员。

默认情况下,Apache Geode 在创建 ClientCache 实例时,会设置一个连接到在 localhost 上运行的 CacheServer 的“DEFAULT”Pool,该 CacheServer 在端口 40404 上监听。CacheServer 在端口 40404 上监听,接受所有系统 NIC 上的连接。您无需执行任何特殊操作即可使用客户端-服务器拓扑。只需在您的服务器端 Spring Boot 应用程序中使用 @CacheServerApplication 注解,在您的客户端端 Spring Boot 应用程序中使用 @ClientCacheApplication 注解,您就可以开始使用了。

如果您愿意,您甚至可以使用 Gfsh 的 start server 命令启动您的服务器。您的 Spring Boot @ClientCacheApplication 仍然可以连接到服务器,无论它如何启动。但是,您可能更喜欢使用 Spring Data for Apache Geode 方法配置和启动您的服务器,因为正确注释的 Spring Boot 应用程序类更直观,更容易调试。

作为应用程序开发人员,您无疑希望自定义 Apache Geode 设置的“DEFAULT”Pool,以可能连接到一个或多个定位器,如下面的示例所示。

使用定位器的基于 Spring 的 Apache Geode ClientCache 应用程序
@SpringBootApplication
@ClientCacheApplication(locators = {
    @Locator(host = "boombox" port = 11235),
    @Locator(host = "skullbox", port = 12480)
})
class ClientApplication { .. }

除了 locators 属性之外,@ClientCacheApplication 注解还具有 servers 属性。servers 属性可用于指定一个或多个嵌套的 @Server 注解,这些注解允许缓存客户端在必要时直接连接到一个或多个服务器。

您可以使用 locatorsservers 属性,但不能同时使用两者(这是由 Apache Geode 强制执行的)。

您还可以使用 @EnablePool@EnablePools 注解配置其他 Pool 实例(除了在使用 @ClientCacheApplication 注解创建 ClientCache 实例时由 Apache Geode 提供的“DEFAULT”Pool 之外)。

@EnablePools 是一个复合注解,它在一个类上聚合了多个嵌套的 @EnablePool 注解。Java 8 及更早版本不允许在一个类上声明多个相同类型的注解。

以下示例使用@EnablePool@EnablePools注解

基于 Spring 的 Apache Geode ClientCache 应用程序,使用多个命名Pools
@SpringBootApplication
@ClientCacheApplication(logLevel = "info")
@EnablePool(name = "VenusPool", servers = @Server(host = "venus", port = 48484),
    min-connections = 50, max-connections = 200, ping-internal = 15000,
    prSingleHopEnabled = true, readTimeout = 20000, retryAttempts = 1,
    subscription-enable = true)
@EnablePools(pools = {
    @EnablePool(name = "SaturnPool", locators = @Locator(host="skullbox", port=20668),
        subsription-enabled = true),
    @EnablePool(name = "NeptunePool", severs = {
            @Server(host = "saturn", port = 41414),
            @Server(host = "neptune", port = 42424)
        }, min-connections = 25))
})
class ClientApplication { .. }

name 属性是@EnablePool注解中唯一必需的属性。正如我们稍后将看到,name属性的值对应于在 Spring 容器中创建的Pool bean 的名称,以及用于引用相应配置属性的名称。它也是 Apache Geode 注册和使用的Pool的名称。

类似地,在服务器端,您可以配置多个CacheServers,客户端可以连接到这些服务器,如下所示

基于 Spring 的 Apache Geode CacheServer 应用程序,使用多个命名CacheServers
@SpringBootApplication
@CacheSeverApplication(logLevel = "info", autoStartup = true, maxConnections = 100)
@EnableCacheServer(name = "Venus", autoStartup = true,
    hostnameForClients = "venus", port = 48484)
@EnableCacheServers(servers = {
    @EnableCacheServer(name = "Saturn", hostnameForClients = "saturn", port = 41414),
    @EnableCacheServer(name = "Neptune", hostnameForClients = "neptune", port = 42424)
})
class ServerApplication { .. }
@EnablePools类似,@EnableCacheServers是一个组合注解,用于将多个@EnableCacheServer注解聚合到单个类中。同样,Java 8 及更早版本不允许在单个类上声明多个相同类型的注解。

细心的读者可能已经注意到,在所有情况下,您都为所有主机名、端口和面向配置的注解属性指定了硬编码值。当应用程序被提升并部署到不同的环境(例如从 DEV 到 QA 到 STAGING 到 PROD)时,这不是理想的。

下一节将介绍如何在运行时处理动态配置。

6.4. 配置和引导定位器

除了 Apache Geode 缓存应用程序之外,您还可以创建 Apache Geode 定位器应用程序。

Apache Geode 定位器是一个 JVM 进程,允许节点作为对等成员加入 Apache Geode 集群。定位器还使客户端能够发现集群中的服务器。定位器为客户端提供元数据,以在集群中的成员之间均匀地平衡负载,启用单跳数据访问操作,以及其他功能。

关于定位器的完整讨论超出了本文档的范围。鼓励读者阅读 Apache Geode 用户指南,以了解有关定位器及其在集群中的作用的更多详细信息。

要配置和引导独立的定位器进程,请执行以下操作

Spring Boot,Apache Geode 定位器应用程序
@SpringBootApplication
@LocatorApplication(port = 12345)
class LocatorApplication { ... }

您可以在集群中启动多个定位器。唯一的要求是成员名称在集群中必须是唯一的。使用@LocatorApplication注解的name属性来相应地命名集群中的成员定位器。或者,您可以在 Spring Boot 的application.properties中设置spring.data.gemfire.locator.name属性。

此外,您必须确保每个定位器都在唯一的端口上启动,如果您在同一台机器上派生多个定位器。设置port注解属性或spring.data.gemfire.locator.port属性。

然后,您可以启动 1 个或多个由定位器(或定位器)加入的 Apache Geode 对等缓存成员,这些定位器也使用 Spring 配置和引导,如下所示

Spring Boot,Apache Geode CacheServer 应用程序,由localhost上的定位器加入,端口为12345
@SpringBootApplication
@CacheServerApplication(locators = "localhost[12345]")
class ServerApplication { ... }

同样,您可以启动任意数量的ServerApplication类,这些类由我们上面的定位器加入,您只需要确保成员的名称是唯一的。

@LocatorApplication 用于配置和引导独立的 Apache Geode Locator 应用程序进程。此进程只能是 Locator,不能是其他任何东西。如果您尝试使用缓存实例启动 Locator,SDG 将抛出错误。

如果您想同时启动缓存实例和嵌入式 Locator,则应使用 @EnableLocator 注解。

在开发过程中启动嵌入式 Locator 很方便。但是,强烈建议您在生产环境中运行独立的 Locator 进程以实现高可用性。如果集群中的所有 Locator 都停止运行,则集群将保持完整,但是,没有新的成员能够加入集群,这对于为了满足需求而进行线性扩展至关重要。

有关更多详细信息,请参阅有关 配置嵌入式 Locator 的部分。

6.5. 使用 Configurers 进行运行时配置

在设计基于注解的配置模型时,另一个目标是在注解属性中保留类型安全。例如,如果配置属性可以用 int(例如端口号)表示,则属性的类型应为 int

不幸的是,这不利于在运行时进行动态和可解析的配置。

Spring 的一个更精细的功能是在 Spring 容器中配置 bean 时,能够在配置元数据的属性或属性中使用属性占位符和 SpEL 表达式。但是,这将要求所有注解属性都为 String 类型,从而放弃类型安全,这是不可取的。

因此,Spring Data for Apache Geode 借鉴了 Spring 中另一个常用的模式,Configurers。Spring Web MVC 中提供了许多不同的 Configurer 接口,包括 org.springframework.web.servlet.config.annotation.ContentNegotiationConfigurer

Configurers 设计模式使应用程序开发人员能够在启动时收到回调以自定义组件或 bean 的配置。框架回调到用户提供的代码以在运行时调整配置。此模式的一个更常见的用途是根据应用程序的运行时环境提供条件配置。

Spring Data for Apache Geode 提供了几个 Configurer 回调接口,用于在运行时自定义基于注解的配置元数据的不同方面,在创建注解的 Spring 管理 bean 之前。

  • CacheServerConfigurer

  • ClientCacheConfigurer

  • ContinuousQueryListenerContainerConfigurer

  • DiskStoreConfigurer

  • IndexConfigurer

  • PeerCacheConfigurer

  • PoolConfigurer

  • RegionConfigurer

  • GatewayReceiverConfigurer

  • GatewaySenderConfigurer

例如,您可以使用CacheServerConfigurerClientCacheConfigurer分别自定义 Spring Boot CacheServerClientCache 应用程序使用的端口号。

考虑以下来自服务器应用程序的示例

使用CacheServerConfigurer自定义 Spring Boot CacheServer 应用程序
@SpringBootApplication
@CacheServerApplication(name = "SpringServerApplication")
class ServerApplication {

  @Bean
  CacheServerConfigurer cacheServerPortConfigurer(
          @Value("${gemfire.cache.server.host:localhost}") String cacheServerHost
          @Value("${gemfire.cache.server.port:40404}") int cacheServerPort) {

      return (beanName, cacheServerFactoryBean) -> {
          cacheServerFactoryBean.setBindAddress(cacheServerHost);
          cacheServerFactoryBean.setHostnameForClients(cacheServerHost);
          cacheServerFactoryBean.setPort(cacheServerPort);
      };
  }
}

接下来,考虑以下来自客户端应用程序的示例

使用ClientCacheConfigurer自定义 Spring Boot ClientCache 应用程序
@SpringBootApplication
@ClientCacheApplication
class ClientApplication {

  @Bean
  ClientCacheConfigurer clientCachePoolPortConfigurer(
          @Value("${gemfire.cache.server.host:localhost}") String cacheServerHost
          @Value("${gemfire.cache.server.port:40404}") int cacheServerPort) {

      return (beanName, clientCacheFactoryBean) ->
          clientCacheFactoryBean.setServers(Collections.singletonList(
              new ConnectionEndpoint(cacheServerHost, cacheServerPort)));
  }
}

通过使用提供的Configurers,您可以在运行时(启动期间)接收回调,以进一步自定义由关联注释在运行时启用的配置。

此外,当Configurer 在 Spring 容器中声明为 bean 时,bean 定义可以利用其他 Spring 容器功能,例如使用@Value 注释在工厂方法参数上的属性占位符、SpEL 表达式等。

Spring Data for Apache Geode 提供的所有Configurers 在回调中获取两部分信息:在 Spring 容器中由注释创建的 bean 的名称,以及对注释用于创建和配置 Apache Geode 组件的FactoryBean 的引用(例如,ClientCache 实例使用ClientCacheFactoryBean 创建和配置)。

SDG FactoryBeans 是 SDG 公共 API 的一部分,如果您没有提供这种新的基于注释的配置模型,您将在 Spring 的基于 Java 的容器配置中使用它。实际上,注释本身正在使用这些相同的FactoryBeans 进行配置。因此,本质上,注释是一个提供额外抽象层的门面,为了方便起见。

鉴于Configurer 可以像任何其他 POJO 一样声明为常规 bean 定义,您可以结合不同的 Spring 配置选项,例如使用带有Conditions 的 Spring Profiles,这些Conditions 使用属性占位符和 SpEL 表达式。这些和其他巧妙的功能让您创建更复杂和灵活的配置。

但是,Configurers 不是唯一的选择。

6.6. 使用Properties 进行运行时配置

除了Configurers 之外,基于注释的配置模型中的每个注释属性都与一个相应的配置属性相关联(以spring.data.gemfire. 为前缀),该属性可以在 Spring Boot application.properties 文件中声明。

基于之前的示例,客户端的application.properties文件将定义以下属性集

客户端application.properties
spring.data.gemfire.cache.log-level=info
spring.data.gemfire.pool.Venus.servers=venus[48484]
spring.data.gemfire.pool.Venus.max-connections=200
spring.data.gemfire.pool.Venus.min-connections=50
spring.data.gemfire.pool.Venus.ping-interval=15000
spring.data.gemfire.pool.Venus.pr-single-hop-enabled=true
spring.data.gemfire.pool.Venus.read-timeout=20000
spring.data.gemfire.pool.Venus.subscription-enabled=true
spring.data.gemfire.pool.Saturn.locators=skullbox[20668]
spring.data.gemfire.pool.Saturn.subscription-enabled=true
spring.data.gemfire.pool.Neptune.servers=saturn[41414],neptune[42424]
spring.data.gemfire.pool.Neptune.min-connections=25

相应的服务器的application.properties文件将定义以下属性

服务器application.properties
spring.data.gemfire.cache.log-level=info
spring.data.gemfire.cache.server.port=40404
spring.data.gemfire.cache.server.Venus.port=43434
spring.data.gemfire.cache.server.Saturn.port=41414
spring.data.gemfire.cache.server.Neptune.port=41414

然后,您可以将@ClientCacheApplication类简化为以下内容

Spring @ClientCacheApplication
@SpringBootApplication
@ClientCacheApplication
@EnablePools(pools = {
    @EnablePool(name = "Venus"),
    @EnablePool(name = "Saturn"),
    @EnablePool(name = "Neptune")
})
class ClientApplication { .. }

同样,@CacheServerApplication类变为以下内容

Spring @CacheServerApplication
@SpringBootApplication
@CacheServerApplication(name = "SpringServerApplication")
@EnableCacheServers(servers = {
    @EnableCacheServer(name = "Venus"),
    @EnableCacheServer(name = "Saturn"),
    @EnableCacheServer(name = "Neptune")
})
class ServerApplication { .. }

前面的示例说明了为什么在某些情况下,即使是必需的,也要“命名”基于注释的 bean。这样做可以从 XML、属性和 Java 中引用 Spring 容器中的 bean。甚至可以将注释定义的 bean 注入应用程序类,无论出于何种目的,如下面的示例所示

@Component
class MyApplicationComponent {

  @Resource(name = "Saturn")
  CacheServer saturnCacheServer;

  ...
}

同样,命名注释定义的 bean 使您可以编写一个Configurer 来自定义特定的“命名” bean,因为beanName 是传递给回调的两个参数之一。

通常,关联的注释属性属性采用两种形式:一个“命名”属性和一个“未命名”属性。

以下示例显示了这种安排

spring.data.gemfire.cache.server.bind-address=10.105.20.1
spring.data.gemfire.cache.server.Venus.bind-address=10.105.20.2
spring.data.gemfire.cache.server.Saturn...
spring.data.gemfire.cache.server.Neptune...

虽然上面有三个名为CacheServers,但也存在一个未命名的CacheServer 属性,它为该属性的任何未指定值提供默认值,即使对于“命名”的CacheServers 也是如此。因此,虽然“Venus”设置并覆盖了自己的bind-address,但“Saturn”和“Neptune”继承自“未命名”的spring.data.gemfire.cache.server.bind-address 属性。

请参阅注释的 Javadoc,了解哪些注释属性支持基于属性的配置,以及它们是否支持“命名”属性而不是默认的“未命名”属性。

6.6.1. Properties of Properties

以通常的 Spring 方式,您甚至可以根据其他Properties 来表达Properties,无论是通过以下示例显示了在application.properties 文件中设置嵌套属性

Properties of Properties
spring.data.gemfire.cache.server.port=${gemfire.cache.server.port:40404}

以下示例显示了在 Java 中设置嵌套属性

Property placehodler nesting
@Bean
CacheServerConfigurer cacheServerPortConfigurer(
    @Value("${gemfire.cache.server.port:${some.other.property:40404}}")
    int cacheServerPort) {
  ...
}
属性占位符嵌套可以任意深度。

6.7. 配置嵌入式服务

Apache Geode 提供了启动许多不同嵌入式服务的能力,这些服务根据用例需要由应用程序使用。

6.7.1. 配置嵌入式定位器

如前所述,Apache Geode 定位器由客户端用于连接到集群并查找集群中的服务器。此外,加入现有集群的新成员使用定位器来查找其对等节点。

对于应用程序开发人员来说,在开发他们的 Spring Boot 和 Spring Data for Apache Geode 应用程序时,启动一个由两个或三个 Apache Geode 服务器组成的小型集群通常很方便。与其启动一个单独的定位器进程,不如使用 @EnableLocator 注解您的 Spring Boot @CacheServerApplication 类,如下所示

Spring、Apache Geode CacheServer 应用程序运行嵌入式定位器
@SpringBootApplication
@CacheServerApplication
@EnableLocator
class ServerApplication { .. }

@EnableLocator 注解在运行在 localhost 上的 Spring Apache Geode CacheServer 应用程序中启动一个嵌入式定位器,监听默认的定位器端口 10334。您可以使用相应的注解属性自定义嵌入式定位器绑定的 host(绑定地址)和 port

或者,您可以通过在 application.properties 中设置相应的 spring.data.gemfire.locator.hostspring.data.gemfire.locator.port 属性来设置 @EnableLocator 属性。

然后,您可以通过连接到此定位器来启动其他启用了 Spring Boot @CacheServerApplication 的应用程序,如下所示

Spring、Apache Geode CacheServer 应用程序连接到定位器
@SpringBootApplication
@CacheServerApplication(locators = "localhost[10334]")
class ServerApplication { .. }

您甚至可以将前面显示的两个应用程序类组合成一个类,并使用您的 IDE 创建不同的运行配置文件配置,以使用 Java 系统属性启动同一类的不同实例,这些实例具有略微修改的配置,如下所示

Spring CacheServer 应用程序运行嵌入式定位器并连接到定位器
@SpringBootApplication
@CacheServerApplication(locators = "localhost[10334]")
public class ServerApplication {

  public static void main(String[] args) {
    SpringApplication.run(ServerApplication.class);
  }

  @EnableLocator
  @Profile("embedded-locator")
  static class Configuration { }

}

然后,对于每个运行配置文件,您可以设置和更改以下系统属性

IDE 运行配置文件配置
spring.data.gemfire.name=SpringCacheServerOne
spring.data.gemfire.cache.server.port=41414
spring.profiles.active=embedded-locator

对于ServerApplication类,只有一个运行配置文件应该设置-Dspring.profiles.active=embedded-locator Java 系统属性。然后,您可以更改其他每个运行配置文件的..name..cache.server.port,并在本地系统上运行一个小型 Apache Geode 服务器集群(分布式系统)。

@EnableLocator注解旨在仅用作开发时注解,而不是应用程序开发人员在生产中使用的注解。我们强烈建议将定位器作为独立的独立进程在集群中运行。

有关 Apache Geode 定位器工作原理的更多详细信息,请参见此处

6.7.2. 配置嵌入式管理器

Apache Geode 管理器是集群中的另一个对等成员或节点,负责集群“管理”。管理包括创建RegionsIndexesDiskStores等,以及监控集群组件的运行时操作和行为。

管理器允许启用 JMX 的客户端(例如Gfsh shell 工具)连接到管理器以管理集群。还可以使用 JDK 提供的工具(例如 JConsole 或 JVisualVM)连接到管理器,因为它们都是启用 JMX 的客户端。

您可能还想将前面显示的 Spring @CacheServerApplication 启用为管理器。为此,请使用@EnableManager注解您的 Spring @Configuration@SpringBootApplication 类。

默认情况下,管理器绑定到localhost,在默认管理器端口1099上监听。管理器的几个方面可以通过注解属性或相应的属性进行配置。

以下示例展示了如何在 Java 中创建嵌入式管理器

运行嵌入式管理器的 Spring CacheServer 应用程序
@SpringBootApplication
@CacheServerApplication(locators = "localhost[10334]")
public class ServerApplication {

  public static void main(String[] args) {
    SpringApplication.run(ServerApplication.class);
  }

  @EnableLocator
  @EnableManager
  @Profile("embedded-locator-manager")
  static class Configuration { }

}

使用前面的类,您甚至可以使用Gfsh 连接到小型集群并对其进行管理,如下所示

$ gfsh
    _________________________     __
   / _____/ ______/ ______/ /____/ /
  / /  __/ /___  /_____  / _____  /
 / /__/ / ____/  _____/ / /    / /
/______/_/      /______/_/    /_/    1.2.1

Monitor and Manage {data-store-name}

gfsh>connect
Connecting to Locator at [host=localhost, port=10334] ..
Connecting to Manager at [host=10.99.199.5, port=1099] ..
Successfully connected to: [host=10.99.199.5, port=1099]

gfsh>list members
         Name          | Id
---------------------- | ----------------------------------------------------
SpringCacheServerOne   | 10.99.199.5(SpringCacheServerOne:14842)<ec><v0>:1024
SpringCacheServerTwo   | 10.99.199.5(SpringCacheServerTwo:14844)<v1>:1025
SpringCacheServerThree | 10.99.199.5(SpringCacheServerThree:14846)<v2>:1026

由于我们还启用了嵌入式定位器,因此我们可以通过定位器间接连接到管理器。定位器允许 JMX 客户端连接并找到集群中的管理器。如果不存在,定位器将承担管理器的角色。但是,如果不存在定位器,我们需要使用以下方法直接连接到管理器

Gfsh connect 命令直接连接到管理器
gfsh>connect --jmx-manager=localhost[1099]
@EnableLocator注解一样,@EnableManager注解也旨在仅用作开发时注解,而不是应用程序开发人员在生产中使用的注解。我们强烈建议管理器(如定位器)在集群中作为独立的、独立的和专用的进程。

有关 Apache Geode 管理和监控的更多详细信息,请访问 此处

6.7.3. 配置嵌入式 HTTP 服务器

Apache Geode 还能够运行嵌入式 HTTP 服务器。当前实现由 Eclipse Jetty 支持。

嵌入式 HTTP 服务器用于托管 Apache Geode 的管理(Admin)REST API(不是公开宣传的 API)、开发者 REST APIPulse 监控 Web 应用程序

但是,要使用任何这些 Apache Geode 提供的 Web 应用程序,您必须在系统上安装完整的 Apache Geode 安装程序,并且必须将 GEODE_HOME 环境变量设置为您的安装目录。

要启用嵌入式 HTTP 服务器,请将 @EnableHttpService 注解添加到任何 @PeerCacheApplication@CacheServerApplication 注解类,如下所示

运行嵌入式 HTTP 服务器的 Spring CacheServer 应用程序
@SpringBootApplication
@CacheServerApplication
@EnableHttpService
public class ServerApplication { .. }

默认情况下,嵌入式 HTTP 服务器在端口 7070 上监听 HTTP 客户端请求。当然,您可以使用注解属性或相应的配置属性根据需要调整端口。

请参阅前面的链接以获取有关 HTTP 支持和提供的服务的更多详细信息。

6.7.4. 配置嵌入式 Memcached 服务器(Gemcached)

Apache Geode 还实现了 Memcached 协议,并能够为 Memcached 客户端提供服务。也就是说,Memcached 客户端可以连接到 Apache Geode 集群并执行 Memcached 操作,就好像集群中的 Apache Geode 服务器是实际的 Memcached 服务器一样。

要启用嵌入式 Memcached 服务,请将 @EnableMemcachedServer 注解添加到任何 @PeerCacheApplication@CacheServerApplication 注解类,如下所示

运行嵌入式 Memcached 服务器的 Spring CacheServer 应用程序
@SpringBootApplication
@CacheServerApplication
@EnabledMemcachedServer
public class ServerApplication { .. }

有关 Apache Geode 的 Memcached 服务(称为“Gemcached”)的更多详细信息,请访问 此处

6.7.5. 配置嵌入式 Redis 服务器

Apache Geode 也实现了 Redis 服务器协议,这使得 Redis 客户端能够连接到 Apache Geode 服务器集群并与之通信以发出 Redis 命令。截至撰写本文时,Apache Geode 中的 Redis 服务器协议支持仍处于实验阶段。

要启用嵌入式 Redis 服务,请将 @EnableRedisServer 注解添加到任何 @PeerCacheApplication@CacheServerApplication 注解的类中,如下所示

运行嵌入式 Redis 服务器的 Spring CacheServer 应用程序
@SpringBootApplication
@CacheServerApplication
@EnableRedisServer
public class ServerApplication { .. }
您必须在 Spring [Boot] 应用程序类路径上显式声明 org.apache.geode:geode-redis 模块。

有关 Apache Geode Redis 适配器的更多详细信息,请参阅 此处

6.8. 配置日志记录

通常,有必要提高日志记录级别以准确了解 Apache Geode 的执行情况和时间。

要启用日志记录,请使用 @EnableLogging 注解您的应用程序类,并设置适当的属性或关联的属性,如下所示

启用了日志记录的 Spring ClientCache 应用程序
@SpringBootApplication
@ClientCacheApplication
@EnableLogging(logLevel="info", logFile="/absolute/file/system/path/to/application.log)
public class ClientApplication { .. }

虽然 logLevel 属性可以与所有基于缓存的应用程序注解一起指定(例如,@ClientCacheApplication(logLevel="info")),但使用 @EnableLogging 注解自定义日志记录行为更容易。

此外,您还可以通过在 application.properties 中设置 spring.data.gemfire.logging.level 属性来配置 log-level

有关更多详细信息,请参阅 @EnableLogging 注解 Javadoc

6.9. 配置统计信息

为了更深入地了解 Apache Geode 的运行时情况,您可以启用统计信息。收集统计数据有助于在发生复杂问题时进行系统分析和故障排除,这些问题通常是分布式的,并且时间是一个关键因素。

启用统计信息后,您可以使用 Apache Geode 的 VSD(可视化统计信息显示) 工具来分析收集的统计数据。

要启用统计信息,请使用 @EnableStatistics 注解您的应用程序类,如下所示

启用统计信息的 Spring ClientCache 应用程序
@SpringBootApplication
@ClientCacheApplication
@EnableStatistics
public class ClientApplication { .. }

在服务器上启用统计信息在评估性能时特别有价值。为此,请使用 @EnableStatistics 注解您的 @PeerCacheApplication@CacheServerApplication 类。

您可以使用 @EnableStatistics 注解属性或关联属性来自定义统计信息收集和收集过程。

有关更多详细信息,请参阅 @EnableStatistics 注解 Javadoc

有关 Apache Geode 统计信息的更多详细信息,请参阅 此处

6.10. 配置 PDX

Apache Geode 的一项更强大的功能是 PDX 序列化。虽然本文档无法全面讨论 PDX,但使用 PDX 进行序列化是 Java 序列化的更好替代方案,具有以下优点

  • PDX 使用集中式类型注册表来使对象的序列化字节更紧凑。

  • PDX 是一种中立的序列化格式,允许 Java 和 Native 客户端在同一数据集上操作。

  • PDX 支持版本控制,并允许在不影响使用旧版或新版 PDX 序列化对象的现有应用程序的情况下添加或删除对象字段,而不会丢失数据。

  • PDX 允许在 OQL 查询投影和谓词中单独访问对象字段,而无需先反序列化对象。

一般来说,在 Apache Geode 中,任何时候数据在客户端和服务器之间传输,或者在集群中的对等节点之间传输,或者在正常分布和复制过程中,以及当数据溢出或持久化到磁盘时,都需要进行序列化。

启用 PDX 序列化比修改所有应用程序域对象类型以实现 java.io.Serializable 更加简单,尤其是在您可能不希望对应用程序域模型施加此类限制,或者您无法控制要序列化的对象时,这种情况在使用第三方库时尤其常见(例如,考虑使用具有 Coordinate 类型的地理空间 API)。

要启用 PDX,请使用 @EnablePdx 注解您的应用程序类,如下所示

启用了 PDX 的 Spring ClientCache 应用程序
@SpringBootApplication
@ClientCacheApplication
@EnablePdx
public class ClientApplication { .. }

通常,应用程序的域对象类型要么实现 org.apache.geode.pdx.PdxSerializable 接口,要么您可以实现并注册 org.apache.geode.pdx.PdxSerializer 接口的非侵入式实现,以处理所有需要序列化的应用程序域对象类型。

不幸的是,Apache Geode 仅允许注册一个 PdxSerializer,这意味着所有应用程序域对象类型都需要由单个 PdxSerializer 实例处理。但是,这是一种严重的反模式,也是一种不可维护的做法。

即使只能向 Apache Geode 注册一个 PdxSerializer 实例,但为每个应用程序域对象类型创建一个 PdxSerializer 实现也是有意义的。

通过使用 组合软件设计模式,您可以提供 PdxSerializer 接口的实现,该实现聚合所有特定于应用程序域对象类型的 PdxSerializer 实例,但充当单个 PdxSerializer 实例并进行注册。

您可以在 Spring 容器中将此组合 PdxSerializer 声明为托管 Bean,并使用 serializerBeanName 属性在 @EnablePdx 注解中通过其 Bean 名称引用此组合 PdxSerializer。Spring Data for Apache Geode 会代表您负责将其注册到 Apache Geode。

以下示例展示了如何创建自定义组合 PdxSerializer

启用 PDX 的 Spring ClientCache 应用程序,使用自定义的复合 PdxSerializer
@SpringBootApplication
@ClientCacheApplication
@EnablePdx(serializerBeanName = "compositePdxSerializer")
public class ClientApplication {

  @Bean
  PdxSerializer compositePdxSerializer() {
      return new CompositePdxSerializerBuilder()...
  }
}

也可以在 Spring 上下文中将 Apache Geode 的 org.apache.geode.pdx.ReflectionBasedAutoSerializer 声明为 Bean 定义。

或者,您应该使用 Spring Data for Apache Geode 的更强大的 org.springframework.data.gemfire.mapping.MappingPdxSerializer,它使用 Spring Data 映射元数据和基础设施应用于序列化过程,以实现比单纯反射更有效的处理。

可以使用 @EnablePdx 注解属性或关联的配置属性调整 PDX 的许多其他方面和功能。

有关更多详细信息,请参阅 @EnablePdx 注解 Javadoc

6.11. 配置 Apache Geode 属性

虽然许多 gemfire.properties 在 SDG 基于注解的配置模型中通过注解方便地封装和抽象,但不太常用的 Apache Geode 属性仍然可以通过 @EnableGemFireProperties 注解访问。

使用 @EnableGemFireProperties 注解您的应用程序类很方便,并且是创建 gemfire.properties 文件或在启动应用程序时将 Apache Geode 属性设置为 Java 系统属性的不错替代方案。

我们建议在将应用程序部署到生产环境时,在 gemfire.properties 文件中设置这些 Apache Geode 属性。但是,在开发阶段,可以根据需要单独设置这些属性,以便进行原型设计、调试和测试。

一些不太常用的 Apache Geode 属性的示例,您通常不必担心,包括但不限于:ack-wait-thresholddisable-tcpsocket-buffer-size 等。

要单独设置任何 Apache Geode 属性,请使用 @EnableGemFireProperties 注解您的应用程序类,并使用相应的属性设置要更改的 Apache Geode 属性,使其与 Apache Geode 设置的默认值不同,如下所示

具有特定 Apache Geode 属性设置的 Spring ClientCache 应用程序
@SpringBootApplication
@ClientCacheApplication
@EnableGemFireProperties(conflateEvents = true, socketBufferSize = 16384)
public class ClientApplication { .. }

请记住,一些 Apache Geode 属性是特定于客户端的(例如,conflateEvents),而另一些是特定于服务器的(例如,distributedSystemIdenableNetworkPartitionDetectionenforceUniqueHostmemberTimeoutredundancyZone 等)。

有关 Apache Geode 属性的更多详细信息,请参阅 此处

6.12. 配置区域

到目前为止,除了 PDX 之外,我们的讨论都集中在配置 Apache Geode 的更多管理功能:创建缓存实例、启动嵌入式服务、启用日志记录和统计信息、配置 PDX 以及使用 gemfire.properties 来影响低级配置和行为。虽然所有这些配置选项都很重要,但它们都没有直接与您的应用程序相关。换句话说,我们仍然需要一些地方来存储我们的应用程序数据,并使其普遍可用和可访问。

Apache Geode 将缓存中的数据组织到 区域 中。您可以将区域视为关系数据库中的表。通常,一个区域应该只存储一种类型的对象,这使得它更适合构建有效的索引和编写查询。我们将在 后面 讨论索引。

以前,Spring Data for Apache Geode 用户需要通过编写非常详细的 Spring 配置元数据来显式定义和声明应用程序用来存储数据的区域,无论是使用 SDG 的 API 中的 FactoryBeans 与 Spring 的 基于 Java 的容器配置,还是使用 XML

以下示例演示了如何在 Java 中配置区域 Bean。

使用 Spring 的基于 Java 的容器配置的示例区域 Bean 定义
@Configuration
class GemFireConfiguration {

  @Bean("Example")
  PartitionedRegionFactoryBean exampleRegion(GemFireCache gemfireCache) {

      PartitionedRegionFactoryBean<Long, Example> exampleRegion =
          new PartitionedRegionFactoryBean<>();

      exampleRegion.setCache(gemfireCache);
      exampleRegion.setClose(false);
      exampleRegion.setPersistent(true);

      return exampleRegion;
  }

  ...
}

以下示例演示了如何在 XML 中配置相同的区域 Bean。

使用 SDG 的 XML 命名空间的示例区域 Bean 定义
<gfe:partitioned-region id="exampleRegion" name="Example" persistent="true">
    ...
</gfe:partitioned-region>

虽然 Java 和 XML 配置都不难指定,但它们都可能很繁琐,尤其是在应用程序需要大量区域的情况下。许多基于关系数据库的应用程序可能拥有数百甚至数千个表。

手动定义和声明所有这些区域将很繁琐且容易出错。现在,有了一种更好的方法。

现在,您可以根据其应用程序域对象(实体)本身来定义和配置区域。您不再需要在 Spring 配置元数据中显式定义 Region Bean 定义,除非您需要更细粒度的控制。

为了简化区域创建,Spring Data for Apache Geode 将 Spring Data Repositories 的使用与使用新的 @EnableEntityDefinedRegions 注解的基于注解的配置的表达能力相结合。

大多数 Spring Data 应用程序开发人员应该已经熟悉 Spring Data 存储库抽象 和 Spring Data for Apache Geode 的 实现/扩展,它经过专门定制以优化 Apache Geode 的数据访问操作。

首先,应用程序开发人员从定义应用程序的域对象(实体)开始,如下所示

应用程序域对象类型,模拟一本书
@Region("Books")
class Book {

  @Id
  private ISBN isbn;

  private Author author;

  private Category category;

  private LocalDate releaseDate;

  private Publisher publisher;

  private String title;

}

接下来,通过扩展 Spring Data Commons 的 org.springframework.data.repository.CrudRepository 接口,定义一个基本的 Books 存储库,如下所示

Books 的存储库
interface BookRepository extends CrudRepository<Book, ISBN> { .. }

org.springframe.data.repository.CrudRepository 是一个数据访问对象 (DAO),它提供基本的数据访问操作 (CRUD) 以及对简单查询的支持(例如 findById(..))。您可以通过在存储库接口上声明查询方法来定义额外的、更复杂的查询(例如,List<BooK> findByAuthor(Author author);)。

在幕后,Spring Data for Apache Geode 在 Spring 容器启动时提供应用程序存储库接口的实现。只要您遵循 约定,SDG 甚至会实现您定义的查询方法。

现在,当您定义 Book 类时,您还通过在实体类型上声明 Spring Data for Apache Geode 映射注释 @Region,指定了 Book 实例映射(存储)到的区域。当然,如果存储库接口(在本例中为 BookRepository)的类型参数中引用的实体类型(在本例中为 Book)没有使用 @Region 进行注释,则该名称将从实体类型的简单类名(在本例中也为 Book)派生。

Spring Data for Apache Geode 使用映射上下文来确定运行时所需的所有区域,该上下文包含应用程序中定义的所有实体的映射元数据。

要启用和使用此功能,请使用 @EnableEntityDefinedRegions 注释应用程序类,如下所示

实体定义的区域配置
@SpringBootApplication
@ClientCacheApplication
@EnableEntityDefinedRegions(basePackages = "example.app.domain")
@EnableGemfireRepositories(basePackages = "example.app.repo")
class ClientApplication { .. }
在应用程序中使用 Spring Data 存储库时,从实体类创建区域最有用。Spring Data for Apache Geode 的存储库支持通过 @EnableGemfireRepositories 注释启用,如前面的示例所示。
目前,只有明确使用 @Region 注释的实体类会被扫描并创建区域。如果实体类没有使用 @Region 明确映射,则不会创建区域。

默认情况下,@EnableEntityDefinedRegions 注解会递归地扫描实体类,从声明 @EnableEntityDefinedRegions 注解的配置类的包开始。

但是,通常通过设置 basePackages 属性来限制扫描期间的搜索,该属性包含包含应用程序实体类的包名。

或者,您可以使用更类型安全的 basePackageClasses 属性来指定要扫描的包,方法是将属性设置为包含实体类的包中的实体类型,或者使用专门为识别要扫描的包而创建的非实体占位符类。

以下示例展示了如何指定要扫描的实体类型

使用实体类类型的实体定义区域配置
@SpringBootApplication
@ClientCacheApplication
@EnableGemfireRepositories
@EnableEntityDefinedRegions(basePackageClasses = {
    example.app.books.domain.Book.class,
    example.app.customers.domain.Customer.class
})
class ClientApplication { .. }

除了指定扫描的起点(类似于 Spring 的 @ComponentScan 注解)之外,您还可以使用 includeexclude 过滤器,它们具有与 org.springframework.context.annotation.ComponentScan.Filter 注解相同的语义。

有关更多详细信息,请参阅 @EnableEntityDefinedRegions 注解 Javadoc

6.12.1. 配置类型特定的区域

Apache Geode 支持许多不同的 区域类型。每种类型对应于区域的 DataPolicy,它决定了区域中的数据将如何管理(例如,分布式、复制等)。

其他配置设置(例如区域的 scope)也会影响数据的管理方式。有关更多详细信息,请参阅 Apache Geode 用户指南中的 “存储和分布选项”

当您使用泛型 @Region 映射注解对应用程序域对象类型进行注解时,Spring Data for Apache Geode 会决定创建哪种类型的区域。SDG 的默认策略在确定要创建的区域类型时会考虑缓存类型。

例如,如果您使用 @ClientCacheApplication 注解将应用程序声明为 ClientCache,SDG 默认情况下会创建一个客户端 PROXY Region。或者,如果您使用 @PeerCacheApplication@CacheServerApplication 注解将应用程序声明为对等 Cache,SDG 默认情况下会创建一个服务器 PARTITION Region

当然,您始终可以在需要时覆盖默认值。要覆盖 Spring Data for Apache Geode 应用的默认值,引入了四个新的区域映射注解

  • @ClientRegion

  • @LocalRegion

  • @PartitionRegion

  • @ReplicateRegion

@ClientRegion 映射注解是特定于客户端应用程序的。上面列出的所有其他 Region 映射注解只能在具有嵌入式对等 Cache 的服务器应用程序中使用。

客户端应用程序有时需要创建和使用仅限本地的 Region,也许是为了聚合来自其他 Region 的数据,以便在本地分析数据并执行应用程序代表用户执行的某些功能。在这种情况下,数据不需要分发回服务器,除非其他应用程序需要访问结果。此 Region 甚至可能是临时的,并在使用后被丢弃,这可以通过 Region 本身的空闲超时 (TTI) 和生存时间 (TTL) 过期策略来实现。(有关过期策略的更多信息,请参见“配置过期”。)

Region 级别的空闲超时 (TTI) 和生存时间 (TTL) 过期策略独立于条目级 TTI 和 TTL 过期策略,并且与之不同。

无论如何,如果您想创建一个仅限本地的客户端 Region,其中数据不会分发回服务器上具有相同名称的对应 Region,您可以声明 @ClientRegion 映射注解并将 shortcut 属性设置为 ClientRegionShortcut.LOCAL,如下所示

具有仅限本地的客户端 Region 的 Spring ClientCache 应用程序
@ClientRegion(shortcut = ClientRegionShortcut.LOCAL)
class ClientLocalEntityType { .. }

所有 Region 类型特定的注解都提供额外的属性,这些属性既是跨 Region 类型通用的,也是特定于该类型 Region 的。例如,PartitionRegion 注解中的 collocatedWithredundantCopies 属性仅适用于服务器端 PARTITION Region。

有关 Apache Geode Region 类型的更多详细信息,请参见 此处

6.12.2. 配置的集群定义的 Region

除了 @EnableEntityDefinedRegions 注解之外,Spring Data for Apache Geode 还提供了反向注解 @EnableClusterDefinedRegions。与其将您的 Region 基于从您的应用程序用例 (UC) 和需求中定义和驱动的实体类(最常见和合乎逻辑的方法),您还可以从连接 ClientCache 应用程序的集群中已定义的 Region 中声明您的 Region。

这使您可以使用服务器集群作为数据定义的主要来源来集中您的配置,并确保集群的所有客户端应用程序都具有一致的配置。这在快速扩展大量相同客户端应用程序实例以处理云管理环境中增加的负载时特别有用。

想法是,与其让客户端应用程序驱动数据字典,不如让用户使用 Apache Geode 的 *Gfsh* CLI shell 工具定义区域。这样做的好处是,当向集群添加更多节点时,这些节点也会拥有并共享相同的配置,因为 Apache Geode 的 *集群配置服务* 会记住它。

例如,用户可以在 *Gfsh* 中定义一个区域,如下所示

使用 Gfsh 定义区域
gfsh>create region --name=Books --type=PARTITION
 Member   | Status
--------- | --------------------------------------
ServerOne | Region "/Books" created on "ServerOne"
ServerTwo | Region "/Books" created on "ServerTwo"

gfsh>list regions
List of regions
---------------
Books

gfsh>describe region --name=/Books
..........................................................
Name            : Books
Data Policy     : partition
Hosting Members : ServerTwo
                  ServerOne

Non-Default Attributes Shared By Hosting Members

 Type  |    Name     | Value
------ | ----------- | ---------
Region | size        | 0
       | data-policy | PARTITION

使用 Apache Geode 的 *集群配置服务*,向服务器集群添加任何额外的节点以处理增加的负载(在后端)时,这些节点也会拥有相同的配置,例如

向集群添加额外的节点
gfsh>list members
  Name    | Id
--------- | ----------------------------------------------
Locator   | 10.0.0.121(Locator:68173:locator)<ec><v0>:1024
ServerOne | 10.0.0.121(ServerOne:68242)<v3>:1025
ServerTwo | 10.0.0.121(ServerTwo:68372)<v4>:1026

gfsh>start server --name=ServerThree --log-level=config --server-port=41414
Starting a Geode Server in /Users/you/geode/cluster/ServerThree...
...
Server in /Users/you/geode/cluster/ServerThree... on 10.0.0.121[41414] as ServerThree is currently online.
Process ID: 68467
Uptime: 3 seconds
Geode Version: 1.2.1
Java Version: 1.8.0_152
Log File: /Users/you/geode/cluster/ServerThree/ServerThree.log
JVM Arguments: -Dgemfire.default.locators=10.0.0.121[10334]
  -Dgemfire.use-cluster-configuration=true
  -Dgemfire.start-dev-rest-api=false
  -Dgemfire.log-level=config
  -XX:OnOutOfMemoryError=kill -KILL %p
  -Dgemfire.launcher.registerSignalHandlers=true
  -Djava.awt.headless=true
  -Dsun.rmi.dgc.server.gcInterval=9223372036854775806
Class-Path: /Users/you/geode/cluster/apache-geode-1.2.1/lib/geode-core-1.2.1.jar
  :/Users/you/geode/cluster/apache-geode-1.2.1/lib/geode-dependencies.jar

gfsh>list members
   Name     | Id
----------- | ----------------------------------------------
Locator     | 10.0.0.121(Locator:68173:locator)<ec><v0>:1024
ServerOne   | 10.0.0.121(ServerOne:68242)<v3>:1025
ServerTwo   | 10.0.0.121(ServerTwo:68372)<v4>:1026
ServerThree | 10.0.0.121(ServerThree:68467)<v5>:1027

gfsh>describe member --name=ServerThree
Name        : ServerThree
Id          : 10.0.0.121(ServerThree:68467)<v5>:1027
Host        : 10.0.0.121
Regions     : Books
PID         : 68467
Groups      :
Used Heap   : 37M
Max Heap    : 3641M
Working Dir : /Users/you/geode/cluster/ServerThree
Log file    : /Users/you/geode/cluster/ServerThree/ServerThree.log
Locators    : 10.0.0.121[10334]

Cache Server Information
Server Bind              :
Server Port              : 41414
Running                  : true
Client Connections       : 0

如您所见,“ServerThree” 现在拥有“Books” 区域。如果任何或所有服务器都宕机,它们在恢复时将拥有相同的配置以及“Books” 区域。

在客户端,可以启动多个书店客户端应用程序实例来处理针对书店在线服务的书籍。 “Books” 区域可能是实现书店应用程序服务所需的许多不同区域之一。与其必须单独创建和配置每个区域,SDG 方便地允许从集群定义客户端应用程序区域,如下所示

使用 @EnableClusterDefinedRegions 从集群定义客户端区域
@ClientCacheApplication
@EnableClusterDefinedRegions
class BookStoreClientApplication {

    public static void main(String[] args) {
        ....
    }

    ...
}
@EnableClusterDefinedRegions 只能在客户端使用。
您可以使用 clientRegionShortcut 注解属性来控制在客户端创建的区域类型。默认情况下,会创建一个客户端 PROXY 区域。将 clientRegionShortcut 设置为 ClientRegionShortcut.CACHING_PROXY 以实现“*近缓存*”。此设置适用于从集群定义的区域创建的所有客户端区域。如果您想控制从集群定义的区域创建的客户端区域的各个设置(如数据策略),那么您可以实现一个 RegionConfigurer,其中包含基于区域名称的自定义逻辑。

然后,在应用程序中使用“Books” 区域就变得很简单。您可以直接注入“Books” 区域,如下所示

使用“Books” 区域
@org.springframework.stereotype.Repository
class BooksDataAccessObject {

    @Resource(name = "Books")
    private Region<ISBN, Book> books;

    // implement CRUD and queries with the "Books" Region
}

或者,甚至可以基于应用程序域类型(实体)Book 定义一个 Spring Data 存储库定义,将其映射到“Books” 区域,如下所示

使用“书籍”区域与 SD 存储库
interface BookRepository extends CrudRepository<Book, ISBN> {
    ...
}

然后,您可以将自定义的 BooksDataAccessObjectBookRepository 注入到您的应用程序服务组件中,以执行所需的任何业务功能。

6.12.3. 配置驱逐

使用 Apache Geode 管理数据是一项活跃的任务。通常需要进行调整,并且您必须使用多种功能(例如,驱逐和 过期)来有效地管理 Apache Geode 中的内存数据。

鉴于 Apache Geode 是一个内存数据网格 (IMDG),数据在内存中进行管理,并分发到参与集群的其他节点,以最大程度地减少延迟,最大限度地提高吞吐量,并确保数据高度可用。由于并非所有应用程序的数据通常都适合内存(即使在整个节点集群中,更不用说单个节点了),您可以通过向集群添加新节点来增加容量。这通常被称为线性扩展(而不是扩展,这意味着添加更多内存、更多 CPU、更多磁盘或更多网络带宽——基本上是更多系统资源来处理负载)。

尽管如此,即使使用节点集群,通常也必须将最重要的数据保留在内存中。内存不足,甚至接近满负荷,很少,如果有的话,是一件好事。停止世界的 GC 甚至更糟,OutOfMemoryErrors 会使您的应用程序彻底停止。

因此,为了帮助管理内存并保留最重要的数据,Apache Geode 支持最近最少使用 (LRU) 驱逐。也就是说,Apache Geode 使用最近最少使用算法根据区域条目上次访问的时间驱逐区域条目。

要启用驱逐,请使用 @EnableEviction 注释应用程序类,如下所示

启用了驱逐的 Spring 应用程序
@SpringBootApplication
@PeerCacheApplication
@EnableEviction(policies = {
    @EvictionPolicy(regionNames = "Books", action = EvictionActionType.INVALIDATE),
    @EvictionPolicy(regionNames = { "Customers", "Orders" }, maximum = 90,
        action = EvictionActionType.OVERFLOW_TO_DISK,
        type = EvictonPolicyType.HEAP_PERCENTAGE)
})
class ServerApplication { .. }

驱逐策略通常在服务器中的区域上设置。

如前所述,policies 属性可以指定一个或多个嵌套的 @EvictionPolicy 注释,每个注释都针对一个或多个需要应用驱逐策略的区域。

此外,您可以参考 Apache Geode 的自定义实现 org.apache.geode.cache.util.ObjectSizer 接口,该接口可以定义为 Spring 容器中的 Bean,并使用 objectSizerName 属性按名称引用。

ObjectSizer 允许您定义用于评估和确定存储在 Region 中的对象大小的标准。

有关驱逐配置选项的完整列表,请参阅 @EnableEviction 注释 Javadoc

有关 Apache Geode 驱逐的更多详细信息,请参阅 此处

6.12.4. 配置过期

除了 驱逐 之外,过期也可以用于通过允许存储在 Region 中的条目过期来管理内存。Apache Geode 支持生存时间 (TTL) 和空闲超时 (TTI) 条目过期策略。

Spring Data for Apache Geode 的基于注释的过期配置基于 Spring Data for Apache Geode 版本 1.5 中添加的早期和现有的条目过期注释支持

本质上,Spring Data for Apache Geode 的过期注释支持基于 Apache Geode 的自定义实现 org.apache.geode.cache.CustomExpiry 接口。此 o.a.g.cache.CustomExpiry 实现检查存储在 Region 中的用户应用程序域对象,以查看是否存在类型级过期注释。

Spring Data for Apache Geode 提供以下过期注释

  • 过期

  • IdleTimeoutExpiration

  • TimeToLiveExpiration

应用程序域对象类型可以使用一个或多个过期注释进行注释,如下所示

应用程序域对象特定过期策略
@Region("Books")
@TimeToLiveExpiration(timeout = 30000, action = "INVALIDATE")
class Book { .. }

要启用过期,请使用 @EnableExpiration 注释应用程序类,如下所示

启用了过期的 Spring 应用程序
@SpringBootApplication
@PeerCacheApplication
@EnableExpiration
class ServerApplication { .. }

除了应用程序域对象类型级过期策略之外,您还可以使用 @EnableExpiration 注释直接在 Region 基础上逐个 Region 地配置过期策略,如下所示

具有特定于 Region 的过期策略的 Spring 应用程序
@SpringBootApplication
@PeerCacheApplication
@EnableExpiration(policies = {
    @ExpirationPolicy(regionNames = "Books", types = ExpirationType.TIME_TO_LIVE),
    @ExpirationPolicy(regionNames = { "Customers", "Orders" }, timeout = 30000,
        action = ExpirationActionType.LOCAL_DESTROY)
})
class ServerApplication { .. }

前面的示例为 BooksCustomersOrders Region 设置了过期策略。

过期策略通常在服务器中的 Region 上设置。

有关过期配置选项的完整列表,请参阅 @EnableExpiration 注解 Javadoc

有关 Apache Geode 过期的更多详细信息,请参阅 此处

6.12.5. 配置压缩

除了 驱逐过期 之外,您还可以使用压缩来配置数据区域以减少内存消耗。

Apache Geode 允许您通过使用可插拔的 Compressors(或不同的压缩编解码器)来压缩内存中的区域值。默认情况下,Apache Geode 使用 Google 的 Snappy 压缩库。

要启用压缩,请使用 @EnableCompression 注解应用程序类,如下所示

启用区域压缩的 Spring 应用程序
@SpringBootApplication
@ClientCacheApplication
@EnableCompression(compressorBeanName = "MyCompressor", regionNames = { "Customers", "Orders" })
class ClientApplication { .. }
compressorBeanNameregionNames 属性都不是必需的。

compressorBeanName 默认值为 SnappyCompressor,启用 Apache Geode 的 SnappyCompressor

regionNames 属性是一个区域名称数组,指定启用了压缩的区域。默认情况下,如果未显式设置 regionNames 属性,则所有区域都会压缩值。

或者,您可以在 application.properties 文件中使用 spring.data.gemfire.cache.compression.compressor-bean-namespring.data.gemfire.cache.compression.region-names 属性来设置和配置这些 @EnableCompression 注解属性的值。
要使用 Apache Geode 的区域压缩功能,您必须在应用程序的 pom.xml 文件(对于 Maven)或 build.gradle 文件(对于 Gradle)中包含 org.iq80.snappy:snappy 依赖项。这仅在您使用 Apache Geode 对区域压缩的默认支持时才需要,默认情况下该支持使用 SnappyCompressor。当然,如果您使用其他压缩库,则需要在应用程序的类路径上包含该压缩库的依赖项。此外,您需要实现 Apache Geode 的 Compressor 接口以适应您选择的压缩库,将其定义为 Spring 压缩器中的 bean,并将 compressorBeanName 设置为此自定义 bean 定义。

有关更多详细信息,请参阅 @EnableCompression 注解 Javadoc

有关 Apache Geode 压缩的更多详细信息,请参见 此处

6.12.6. 配置堆外内存

使用 Apache Geode 的堆外内存支持是减少 JVM 堆内存压力和最大程度减少 GC 活动的另一种有效方法。

与将区域条目存储在 JVM 堆上不同,条目存储在系统的主内存中。如 Apache Geode 用户指南 中所述,堆外内存通常在存储的对象大小一致、大部分小于 128K 且不需要频繁反序列化时效果最佳。

要启用堆外内存,请使用 @EnableOffHeap 注释应用程序类,如下所示

启用堆外内存的 Spring 应用程序
@SpringBootApplication
@PeerCacheApplication
@EnableOffHeap(memorySize = 8192m regionNames = { "Customers", "Orders" })
class ServerApplication { .. }

memorySize 属性是必需的。memorySize 属性的值指定区域可以在主内存中使用的内存量,以兆字节 (m) 或千兆字节 (g) 为单位。

regionNames 属性是区域名称的数组,指定在主内存中存储条目的区域。默认情况下,如果未显式设置 regionNames 属性,则所有区域都使用主内存。

或者,您可以在 application.properties 文件中使用 spring.data.gemfire.cache.off-heap.memory-sizespring.data.gemfire.cache.off-heap.region-names 属性来设置和配置这些 @EnableOffHeap 注释属性的值。

有关更多详细信息,请参见 @EnableOffHeap 注释 Javadoc

6.12.7. 配置磁盘存储

或者,您可以配置区域将数据持久化到磁盘。您还可以配置区域在区域条目被逐出时将数据溢出到磁盘。在这两种情况下,都需要一个 DiskStore 来持久化和/或溢出数据。当未为具有持久性或溢出的区域显式配置 DiskStore 时,Apache Geode 使用 DEFAULT DiskStore

我们建议在将数据持久化和/或溢出到磁盘时定义特定于区域的 DiskStores

Spring Data for Apache Geode 通过使用 @EnableDiskStore@EnableDiskStores 注释注释应用程序类,为定义和创建应用程序区域 DiskStores 提供注释支持。

@EnableDiskStores 是一个复合注释,用于聚合一个或多个 @EnableDiskStore 注释。

例如,虽然 Book 信息可能主要来自某些外部数据源(例如亚马逊)的参考数据,但 Order 数据很可能具有事务性,并且应用程序需要保留(甚至可能在事务量足够大时溢出到磁盘)——或者任何图书出版商和作者都希望如此。

使用@EnableDiskStore注解,您可以定义和创建DiskStore,如下所示

定义DiskStore的Spring应用程序
@SpringBootApplication
@PeerCacheApplication
@EnableDiskStore(name = "OrdersDiskStore", autoCompact = true, compactionThreshold = 70,
    maxOplogSize = 512, diskDirectories = @DiskDiretory(location = "/absolute/path/to/order/disk/files"))
class ServerApplication { .. }

同样,可以使用复合注解@EnableDiskStores定义多个DiskStore

与Spring Data for Apache Geode中基于注解的配置模型中的其他注解一样,@EnableDiskStore@EnableDiskStores都有许多属性以及相关的配置属性,用于在运行时自定义创建的DiskStores

此外,@EnableDiskStores注解定义了某些适用于所有DiskStore的通用DiskStore属性,这些DiskStore是由@EnableDiskStore注解与@EnableDiskStores注解本身组合创建的。单个DiskStore配置会覆盖特定的全局设置,但@EnableDiskStores注解方便地定义了适用于注解聚合的所有DiskStores的通用配置属性。

Spring Data for Apache Geode还提供了DiskStoreConfigurer回调接口,可以在Java配置中声明该接口,并用它来代替配置属性在运行时自定义DiskStore,如下例所示

具有自定义DiskStore配置的Spring应用程序
@SpringBootApplication
@PeerCacheApplication
@EnableDiskStore(name = "OrdersDiskStore", autoCompact = true, compactionThreshold = 70,
    maxOplogSize = 512, diskDirectories = @DiskDiretory(location = "/absolute/path/to/order/disk/files"))
class ServerApplication {

  @Bean
  DiskStoreConfigurer ordersDiskStoreDiretoryConfigurer(
          @Value("${orders.disk.store.location}") String location) {

      return (beanName, diskStoreFactoryBean) -> {

          if ("OrdersDiskStore".equals(beanName) {
              diskStoreFactoryBean.setDiskDirs(Collections.singletonList(new DiskDir(location));
          }
      }
  }
}

有关可用属性以及相关配置属性的更多详细信息,请参阅@EnableDiskStore@EnableDiskStores注解Javadoc。

有关Apache Geode区域持久性和溢出(使用DiskStores)的更多详细信息,请参见此处

6.12.8. 配置索引

除非可以访问数据,否则在区域中存储数据没有多大用处。

除了Region.get(key)操作(尤其是在预先知道键的情况下),通常通过对包含数据的区域执行查询来检索数据。使用Apache Geode,查询是使用对象查询语言(OQL)编写的,客户端希望访问的特定数据集在查询的谓词中表达(例如,SELECT * FROM /Books b WHERE b.author.name = 'Jon Doe')。

通常,没有索引的查询效率低下。在没有索引的情况下执行查询时,Apache Geode执行相当于完整表扫描的操作。

索引是为查询谓词中使用的对象上的字段创建和维护的,以匹配查询投影所表达的感兴趣数据。可以创建不同类型的索引,例如哈希索引。

Spring Data for Apache Geode使在存储和访问数据的区域上创建索引变得容易。我们不再需要使用Spring配置显式声明Index bean定义,而是可以像下面这样在Java中创建Index bean定义

使用 Java 配置定义索引 Bean
@Bean("BooksIsbnIndex")
IndexFactoryBean bookIsbnIndex(GemFireCache gemfireCache) {

    IndexFactoryBean bookIsbnIndex = new IndexFactoryBean();

    bookIsbnIndex.setCache(gemfireCache);
    bookIsbnIndex.setName("BookIsbnIndex");
    bookIsbnIndex.setExpression("isbn");
    bookIsbnIndex.setFrom("/Books"));
    bookIsbnIndex.setType(IndexType.KEY);

    return bookIsbnIndex;
}

或者,我们可以使用 XML 创建一个 Index Bean 定义,如下所示

使用 XML 定义索引 Bean
<gfe:index id="BooksIsbnIndex" expression="isbn" from="/Books" type="KEY"/>

但是,现在您可以直接在应用程序域对象类型的字段上定义索引,这些字段您知道将在查询谓词中使用以加快这些查询的速度。您甚至可以为从应用程序的存储库接口上的用户定义查询方法生成的 OQL 查询应用索引。

重新使用前面示例中的 Book 实体类,我们可以对 Book 上的字段进行注释,这些字段我们知道在使用 BookRepository 接口中的查询方法定义的查询中使用,如下所示

使用索引对书籍进行建模的应用程序域对象类型
@Region("Books")
class Book {

  @Id
  private ISBN isbn;

  @Indexed
  private Author author;

  private Category category;

  private LocalDate releaseDate;

  private Publisher publisher;

  @LuceneIndexed
  private String title;

}

在我们的新 Book 类定义中,我们使用 @Indexedauthor 字段进行了注释,使用 @LuceneIndexedtitle 字段进行了注释。此外,isbn 字段之前已使用 Spring Data 的 @Id 注释进行注释,该注释标识包含 Book 实例唯一标识符的字段,并且在 Spring Data for Apache Geode 中,@Id 注释的字段或属性用作存储条目时 Region 中的键。

  • @Id 注释的字段或属性会导致创建 Apache Geode KEY 索引。

  • @Indexed 注释的字段或属性会导致创建 Apache Geode HASH 索引(默认值)。

  • @LuceneIndexed 注释的字段或属性会导致创建 Apache Geode Lucene 索引,该索引用于 Apache Geode 的 Lucene 集成和支持的基于文本的搜索。

当使用 @Indexed 注释而不设置任何属性时,索引的 nameexpressionfromClause 将从添加了 @Indexed 注释的类的字段或属性派生。expression 恰好是字段或属性的名称。fromClause 从域对象的类的 @Region 注释派生,或者如果未指定 @Region 注释,则从域对象的类的简单名称派生。

当然,您可以显式设置任何 @Indexed 注释属性以覆盖 Spring Data for Apache Geode 提供的默认值。

使用自定义索引对书籍进行建模的应用程序域对象类型
@Region("Books")
class Book {

  @Id
  private ISBN isbn;

  @Indexed(name = "BookAuthorNameIndex", expression = "author.name", type = "FUNCTIONAL")
  private Author author;

  private Category category;

  private LocalDate releaseDate;

  private Publisher publisher;

  @LuceneIndexed(name = "BookTitleIndex", destory = true)
  private String title;

}

索引的 name(在未显式设置时自动生成)也用作 Spring 容器中为索引注册的 Bean 的名称。如有必要,此索引 Bean 甚至可以通过名称注入到另一个应用程序组件中。

索引的生成名称遵循以下模式:<Region Name><Field/Property Name><Index Type>Idx。例如,author 索引的名称将是 BooksAuthorHashIdx

要启用索引,请使用@EnableIndexing注释应用程序类,如下所示

启用了索引的 Spring 应用程序
@SpringBootApplication
@PeerCacheApplication
@EnableEntityDefinedRegions
@EnableIndexing
class ServerApplication { .. }
除非还声明了@EnableEntityDefinedRegions,否则@EnablingIndexing注释无效。本质上,索引是从实体类类型上的字段或属性定义的,并且必须扫描实体类以检查实体的字段和属性中是否存在索引注释。如果没有此扫描,则无法找到索引注释。我们还强烈建议您限制扫描范围。

虽然 Spring Data for Apache Geode 存储库目前不支持 Lucene 查询,但 SDG 通过使用熟悉的 Spring 模板设计模式为 Apache Geode Lucene 查询提供了全面的支持

最后,我们以一些使用索引时需要牢记的额外提示来结束本节

  • 虽然执行 OQL 查询不需要 OQL 索引,但执行 Lucene 基于文本的搜索需要 Lucene 索引。

  • OQL 索引不会持久保存到磁盘。它们只在内存中维护。因此,当 Apache Geode 节点重新启动时,必须重建索引。

  • 您还需要注意维护索引相关的开销,特别是由于索引专门存储在内存中,尤其是在更新 Region 条目时。索引“维护”可以配置为异步任务。

当您重新启动需要重建索引的 Spring 应用程序时,您可以使用的另一种优化方法是首先预先定义所有索引,然后一次性创建它们,这在 Spring Data for Apache Geode 中是在 Spring 容器刷新时发生的。

您可以通过将@EnableIndexing注释上的define属性设置为true来预先定义索引,然后一次性创建它们。

有关更多详细信息,请参阅 Apache Geode 用户指南中的“一次创建多个索引”

创建合理的索引是一项重要的任务,因为设计不当的索引可能会弊大于利。

有关配置选项的完整列表,请参阅 @Indexed 注解和 @LuceneIndexed 注解的 Javadoc 文档。

有关 Apache Geode OQL 查询的更多详细信息,请 点击此处

有关 Apache Geode 索引的更多详细信息,请 点击此处

有关 Apache Geode Lucene 查询的更多详细信息,请 点击此处

6.13. 配置持续查询

Apache Geode 的另一个非常重要且有用的功能是 持续查询

在互联网时代,事件和数据流来自各个地方。能够处理和处理大量数据流并实时响应事件对于许多应用程序来说越来越重要。自动驾驶汽车就是一个例子。能够实时接收、过滤、转换、分析和处理数据是实时应用程序的关键差异和特征。

幸运的是,Apache Geode 在这方面领先于时代。通过使用持续查询 (CQ),客户端应用程序可以表达其感兴趣的数据或事件,并注册监听器来处理和处理发生的事件。客户端应用程序可能感兴趣的数据以 OQL 查询的形式表达,其中查询谓词用于过滤或识别感兴趣的数据。当数据发生更改或添加并且它与注册的 CQ 的查询谓词中定义的条件匹配时,将通知客户端应用程序。

Spring Data for Apache Geode 使得定义和注册 CQ 变得容易,以及一个关联的监听器来处理和处理 CQ 事件,而无需 Apache Geode 的所有管道。SDG 的基于注解的 CQ 配置建立在 持续查询监听器容器 中现有的持续查询支持之上。

例如,假设一个银行应用程序注册了对每个客户的支票账户的兴趣,以检测透支取款并通过应用透支保护或通知客户来处理此事件。然后,应用程序可能会注册以下 CQ

带有注册的 CQ 和监听器的 Spring ClientCache 应用程序。
@SpringBootApplication
@ClientCacheApplication(subcriptionEnabled = true)
@EnableContinuousQueries
class PublisherPrintApplication {

    @ContinuousQuery(name = "OverdraftProtection", query = "SELECT * FROM /CheckingAccount ca WHERE ca.balance < 0.0")
    void handleOverdraft(CqEvent event) {
        // Quick!!! Put more money into the checking account or notify the customer of the checking account!
    }
}

要启用持续查询,请使用 @EnableContinuousQueries 注解您的应用程序类。

定义连续查询包括使用 @ContinuousQuery 注解(类似于 SDG 的 Function 注解的 POJO 方法)来注释任何 Spring @Component 注解的 POJO 类方法。使用 @ContinuousQuery 注解定义的 POJO 方法会在每次添加或更改与查询谓词匹配的数据时被调用。

此外,POJO 方法签名应符合 ContinuousQueryListenerContinuousQueryListenerAdapter 部分中概述的要求。

有关可用属性和配置设置的更多详细信息,请参阅 @EnableContinuousQueries@ContinuousQuery 注解 Javadoc。

有关 Spring Data for Apache Geode 的连续查询支持的更多详细信息,请参阅 此处

有关 Apache Geode 的连续查询的更多详细信息,请参阅 此处

6.14. 配置 Spring 的缓存抽象

使用 Spring Data for Apache Geode,Apache Geode 可用作 Spring 的 缓存抽象 中的缓存提供者。

在 Spring 的缓存抽象中,缓存注解(例如 @Cacheable)标识在调用可能很昂贵的操作之前执行缓存查找的缓存。应用程序服务方法的结果在调用操作后被缓存。

在 Spring Data for Apache Geode 中,Spring Cache 直接对应于 Apache Geode Region。在调用任何缓存注释的应用程序服务方法之前,Region 必须存在。这适用于任何 Spring 的缓存注解(即 @Cacheable@CachePut@CacheEvict),这些注解标识在服务操作中使用的缓存。

例如,我们的发布商的销售点 (PoS) 应用程序可能具有在销售交易期间确定或查找 BookPrice 的功能,如下例所示

@Service
class PointOfSaleService

  @Cacheable("BookPrices")
  Price runPriceCheckFor(Book book) {
      ...
  }

  @Transactional
  Receipt checkout(Order order) {
      ...
  }

  ...
}

为了简化您在将 Spring Data for Apache Geode 与 Spring 的缓存抽象一起使用时的工作,我们在基于注解的配置模型中添加了两个新功能。

请考虑以下 Spring 缓存配置

使用 Apache Geode 作为缓存提供者启用缓存
@EnableCaching
class CachingConfiguration {

  @Bean
  GemfireCacheManager cacheManager(GemFireCache gemfireCache) {

      GemfireCacheManager cacheManager = new GemfireCacheManager();

      cacheManager.setCache(gemfireCache);

      return cacheManager;
  }

  @Bean("BookPricesCache")
  ReplicatedRegionFactoryBean<Book, Price> bookPricesRegion(GemFireCache gemfireCache) {

    ReplicatedRegionFactoryBean<Book, Price> bookPricesRegion =
        new ReplicatedRegionFactoryBean<>();

    bookPricesRegion.setCache(gemfireCache);
    bookPricesRegion.setClose(false);
    bookPricesRegion.setPersistent(false);

    return bookPricesRegion;
  }

  @Bean("PointOfSaleService")
  PointOfSaleService pointOfSaleService(..) {
      return new PointOfSaleService(..);
  }
}

使用 Spring Data for Apache Geode 的新功能,您可以将相同的缓存配置简化为以下内容

启用 Apache Geode 缓存
@EnableGemfireCaching
@EnableCachingDefinedRegions
class CachingConfiguration {

  @Bean("PointOfSaleService")
  PointOfSaleService pointOfSaleService(..) {
      return new PointOfSaleService(..);
  }
}

首先,@EnableGemfireCaching 注解替换了 Spring 的 @EnableCaching 注解,以及在 Spring 配置中声明显式 CacheManager bean 定义(名为“cacheManager”)的需要。

其次,@EnableCachingDefinedRegions 注解,类似于“配置区域”中描述的 @EnableEntityDefinedRegions 注解,会检查整个 Spring 应用程序,缓存带注解的服务组件以识别应用程序运行时所需的所有缓存,并在应用程序启动时为这些缓存创建 Apache Geode 中的区域。

创建的区域对于创建区域的应用程序进程是本地的。如果应用程序是 peer Cache,则区域仅存在于应用程序节点上。如果应用程序是 ClientCache,则 SDG 会创建客户端 PROXY 区域,并期望这些区域在集群中的服务器上已经存在,并且具有相同的名称。

SDG 无法使用 Spring CacheResolver 在运行时确定服务方法所需的缓存,以解析操作中使用的缓存。
SDG 还支持应用程序服务组件上的 JCache(JSR-107)缓存注解。有关在 JCache 缓存注解代替的地方使用的等效 Spring 缓存注解,请参阅核心 Spring 框架参考指南

有关在 Spring 的缓存抽象中使用 Apache Geode 作为缓存提供程序的更多详细信息,请参阅 “支持 Spring 缓存抽象” 部分。

有关 Spring 缓存抽象的更多详细信息,请参阅 此处

6.15. 配置集群配置推送

这可能是 Spring Data for Apache Geode 中最令人兴奋的新功能。

当客户端应用程序类使用 @EnableClusterConfiguration 注解时,任何在 Spring 容器中定义和声明为 bean 的区域或索引(由客户端应用程序定义)都会“推送”到客户端连接到的服务器集群。不仅如此,这种“推送”是以 Apache Geode 在使用 HTTP 时记住客户端推送的配置的方式执行的。如果集群中的所有节点都宕机,它们会以与之前相同的配置恢复。如果向集群添加新的服务器,它将获取相同的配置。

从某种意义上说,此功能与使用 Gfsh 手动在集群中的所有服务器上创建区域和索引并没有太大区别。不同的是,现在使用 Spring Data for Apache Geode,您不再需要使用 Gfsh 来创建区域和索引。您的 Spring Boot 应用程序,在 Spring Data for Apache Geode 的强大功能的支持下,已经包含了创建区域和索引所需的所有配置元数据。

当您使用 Spring Data Repository 抽象时,我们知道您的应用程序需要的所有区域(例如由 @Region 注释的实体类定义的区域)和索引(例如由 @Indexed 注释的实体字段和属性定义的索引)。

当您使用 Spring 的缓存抽象时,我们还知道应用程序服务组件所需的缓存注释中标识的所有缓存的区域。

从本质上讲,您已经告诉我们所有需要知道的信息,只需使用 Spring 框架开发您的应用程序,只需使用其所有 API 和功能,无论是在注释元数据、Java、XML 中表达,还是其他方式,无论是用于配置、映射还是任何目的。

关键是,您可以专注于应用程序的业务逻辑,同时使用框架的功能和支持基础设施(例如 Spring 的缓存抽象、Spring Data Repositories、Spring 的事务管理等等),Spring Data for Apache Geode 会代表您处理所有这些框架功能所需的 Apache Geode 管道。

将配置从客户端推送到集群中的服务器并让集群记住它,这部分得益于 Apache Geode 的 集群配置 服务。Apache Geode 的集群配置服务也是 Gfsh 用于记录用户从 shell 向集群发出的与模式相关的更改(例如,gfsh> create region --name=Example --type=PARTITION)的相同服务。

当然,由于集群可能会“记住”先前运行中客户端推送的先前配置,因此 Spring Data for Apache Geode 会谨慎地避免覆盖服务器中已定义的任何现有区域和索引。这在区域已经包含数据时尤其重要!

目前,没有选项可以覆盖任何现有的区域或索引定义。要重新创建区域或索引,您必须使用 Gfsh 先销毁区域或索引,然后重新启动客户端应用程序,以便将配置再次推送到服务器。或者,您可以使用 Gfsh 手动(重新)定义区域和索引。
Gfsh 不同,Spring Data for Apache Geode 仅支持从客户端在服务器上创建区域和索引。对于高级配置和用例,您应该使用 Gfsh 管理(服务器端)集群。
要使用此功能,您必须在 Spring、Apache Geode ClientCache 应用程序的类路径中显式声明 org.springframework:spring-web 依赖项。

考虑以下配置中表达的力量

Spring ClientCache 应用程序
@SpringBootApplication
@ClientCacheApplication
@EnableCachingDefinedRegions
@EnableEntityDefinedRegions
@EnableIndexing
@EnableGemfireCaching
@EnableGemfireRepositories
@EnableClusterConfiguration
class ClientApplication { .. }

您将立即获得一个具有 Apache Geode ClientCache 实例、Spring Data Repositories、Spring 的缓存抽象(以 Apache Geode 作为缓存提供者)的 Spring Boot 应用程序(其中区域和索引不仅在客户端创建,而且被推送到集群中的服务器)。

从那里开始,您只需要执行以下操作

  • 定义应用程序的域模型对象,并使用映射和索引注释进行注释。

  • 定义存储库接口以支持每个实体类型的基本数据访问操作和简单查询。

  • 定义包含处理实体的业务逻辑的服务组件。

  • 在需要缓存、事务行为等的 service 方法上声明相应的注释。

在本例中,与应用程序后端服务(如 Apache Geode)所需的架构和管道无关。数据库用户具有类似的功能。现在 Spring 和 Apache Geode 开发人员也拥有了。

当与以下 Spring Data for Apache Geode 注释结合使用时,此应用程序几乎无需任何努力即可开始运行

  • @EnableContinuousQueries

  • @EnableGemfireFunctionExecutions

  • @EnableGemfireCacheTransactions

有关更多详细信息,请参阅 @EnableClusterConfiguration 注释 Javadoc

6.16. 配置 SSL

将数据序列化以通过网络传输与在传输过程中保护数据一样重要。当然,在 Java 中实现此目的的常用方法是使用安全套接字扩展 (SSE) 和传输层安全 (TLS)。

要启用 SSL,请使用 @EnableSsl 注释您的应用程序类,如下所示

启用了 SSL 的 Spring ClientCache 应用程序
@SpringBootApplication
@ClientCacheApplication
@EnableSsl
public class ClientApplication { .. }

然后,您需要设置必要的 SSL 配置属性或属性:密钥库、用户名/密码等。

您可以分别使用 SSL 配置不同的 Apache Geode 组件(GATEWAYHTTPJMXLOCATORSERVER),也可以使用 CLUSTER 枚举值将它们集体配置为使用 SSL。

您可以使用嵌套的 @EnableSsl 注释、components 属性以及来自 Component 枚举的枚举值来指定应应用 SSL 配置设置的 Apache Geode 组件,如下所示

通过组件启用了 SSL 的 Spring ClientCache 应用程序
@SpringBootApplication
@ClientCacheApplication
@EnableSsl(components = { GATEWAY, LOCATOR, SERVER })
public class ClientApplication { .. }

此外,您还可以使用相应的注释属性或关联的配置属性来指定组件级 SSL 配置(ciphersprotocolskeystore/truststore 信息)。

有关更多详细信息,请参阅 @EnableSsl 注释 Javadoc

有关 Apache Geode SSL 支持的更多详细信息,请参阅 此处

6.17. 配置安全性

毫无疑问,应用程序安全性极其重要,Spring Data for Apache Geode 为保护 Apache Geode 客户端和服务器提供了全面的支持。

最近,Apache Geode 引入了一个新的 集成安全 框架(取代了旧的身份验证和授权安全模型)来处理身份验证和授权。这个新安全框架的主要功能和优势之一是它与 Apache Shiro 集成,因此可以将身份验证和授权请求委托给 Apache Shiro 来执行安全策略。

本节的其余部分将演示 Spring Data for Apache Geode 如何进一步简化 Apache Geode 的安全故事。

6.17.1. 配置服务器安全

您可以通过多种不同的方式为 Apache Geode 集群中的服务器配置安全。

  • 实现 Apache Geode 的 org.apache.geode.security.SecurityManager 接口,并将 Apache Geode 的 security-manager 属性设置为使用完全限定的类名引用您的应用程序 SecurityManager 实现。或者,用户可以构造并初始化其 SecurityManager 实现的实例,并在创建 Apache Geode 对等 Cache 时使用 CacheFactory.setSecurityManager(:SecurityManager) 方法设置它。

  • 创建一个 Apache Shiro shiro.ini 文件,其中包含为您的应用程序定义的用户、角色和权限,然后将 Apache Geode 的 security-shiro-init 属性设置为引用此 shiro.ini 文件,该文件必须在 CLASSPATH 中可用。

  • 仅使用 Apache Shiro,使用 Spring Data for Apache Geode 的新 @EnableSecurity 注解注释您的 Spring Boot 应用程序类,并在 Spring 容器中定义一个或多个 Apache Shiro Realms 作为 bean,以访问您的应用程序的安全元数据(即授权用户、角色和权限)。

第一种方法的问题在于您必须实现自己的 SecurityManager,这可能非常繁琐且容易出错。实现自定义 SecurityManager 在从存储元数据的任何数据源(例如 LDAP 或甚至专有内部数据源)访问安全元数据方面提供了一些灵活性。但是,这个问题已经通过配置和使用 Apache Shiro Realms 解决,后者更广为人知且不特定于 Apache Geode。

请参阅 Apache Geode 的安全示例,了解 身份验证授权,作为实现您自己的自定义应用程序特定 SecurityManager 的一种可能方法。但是,我们强烈建议 **不要** 这样做。

第二种方法是使用 Apache Shiro INI 文件,虽然略好一些,但首先您仍然需要熟悉 INI 文件格式。此外,INI 文件是静态的,在运行时不容易更新。

第三种方法是最理想的,因为它遵循广为人知且业界认可的概念(即 Apache Shiro 的安全框架),并且易于设置,如下例所示

使用 Apache Shiro 的 Spring 服务器应用程序
@SpringBootApplication
@CacheServerApplication
@EnableSecurity
class ServerApplication {

  @Bean
  PropertiesRealm shiroRealm() {

      PropertiesRealm propertiesRealm = new PropertiesRealm();

      propertiesRealm.setResourcePath("classpath:shiro.properties");
      propertiesRealm.setPermissionResolver(new GemFirePermissionResolver());

      return propertiesRealm;
  }
}
在前面的示例中,配置的 Realm 可以轻松地成为 Apache Shiro 支持的任何 Realm

您甚至可以创建 Apache Shiro Realm 的自定义实现。

有关更多详细信息,请参阅 Apache Shiro 的 关于 Realms 的文档

当 Apache Shiro 位于集群中服务器的 CLASSPATH 上,并且一个或多个 Apache Shiro Realm 已在 Spring 容器中定义为 bean 时,Spring Data for Apache Geode 会检测到此配置,并使用 Apache Shiro 作为安全提供程序来保护您的 Apache Geode 服务器,前提是使用了 @EnableSecurity 注解。

您可以在此 spring.io 博客文章 中找到有关 Spring Data for Apache Geode 支持 Apache Geode 使用 Apache Shiro 的新集成安全框架的更多信息。

有关可用属性和相关配置属性的更多详细信息,请参阅 @EnableSecurity 注解 Javadoc。

有关 Apache Geode 安全的更多详细信息,请参阅 此处

6.17.2. 配置客户端安全

如果没有讨论如何保护基于 Spring 的 Apache Geode 缓存客户端应用程序,安全故事将不完整。

Apache Geode 保护客户端应用程序的过程实际上相当复杂。简而言之,您需要

  1. 提供 org.apache.geode.security.AuthInitialize 接口的实现。

  2. 将 Apache Geode 的 security-client-auth-init(系统)属性设置为引用自定义的、应用程序提供的 AuthInitialize 接口。

  3. 在专有的 Apache Geode gfsecurity.properties 文件中指定用户凭据。

Spring Data for Apache Geode 通过使用与服务器应用程序中使用的相同 @EnableSecurity 注解来简化所有这些步骤。换句话说,相同的 @EnableSecurity 注解处理客户端和服务器应用程序的安全。当用户决定将应用程序从嵌入式、对等 Cache 应用程序切换到 ClientCache 应用程序时,此功能使操作变得更加容易,例如。只需将 SDG 注解从 @PeerCacheApplication@CacheServerApplication 更改为 @ClientCacheApplication,就完成了。

实际上,您在客户端上需要做的只是以下操作

使用 @EnableSecurity 的 Spring 客户端应用程序
@SpringBootApplication
@ClientCacheApplication
@EnableSecurity
class ClientApplication { .. }

然后,您可以定义熟悉的 Spring Boot application.properties 文件,其中包含所需的用户名和密码,如下面的示例所示,您就完成了所有设置

包含所需安全凭据的 Spring Boot application.properties 文件
spring.data.gemfire.security.username=jackBlack
spring.data.gemfire.security.password=b@cK!nB1@cK
默认情况下,Spring Boot 可以在应用程序的 CLASSPATH 根目录中找到您的 application.properties 文件。当然,Spring 支持使用其 资源抽象 来定位资源的多种方法。

有关可用属性和相关配置属性的更多详细信息,请参阅 @EnableSecurity 注解 Javadoc。

有关 Apache Geode 安全的更多详细信息,请参见 此处

6.18. 配置提示

以下提示可以帮助您充分利用新的基于注解的配置模型

6.18.1. 配置组织

正如我们在关于 “配置集群配置推送” 的部分中所看到的,当使用注解启用许多 Apache Geode 或 Spring Data for Apache Geode 功能时,我们开始在 Spring @Configuration@SpringBootApplication 类上堆叠大量注解。在这种情况下,开始对配置进行一些分隔是有意义的。

例如,请考虑以下声明

具有所有功能的 Spring ClientCache 应用程序
@SpringBootApplication
@ClientCacheApplication
@EnableContinuousQueries
@EnableCachingDefinedRegions
@EnableEntityDefinedRegions
@EnableIndexing
@EnableGemfireCacheTransactions
@EnableGemfireCaching
@EnableGemfireFunctionExecutions
@EnableGemfireRepositories
@EnableClusterConfiguration
class ClientApplication { .. }

我们可以按以下关注点细分此配置

带有“厨房水槽”的 Spring ClientCache 应用程序
@SpringBootApplication
@Import({ GemFireConfiguration.class, CachingConfiguration.class,
    FunctionsConfiguration.class, QueriesConfiguration.class,
    RepositoriesConfiguration.class })
class ClientApplication { .. }

@ClientCacheApplication
@EnableClusterConfiguration
@EnableGemfireCacheTransactions
class GemFireConfiguration { .. }

@EnableGemfireCaching
@EnableCachingDefinedRegions
class CachingConfiguration { .. }

@EnableGemfireFunctionExecutions
class FunctionsConfiguration { .. }

@EnableContinuousQueries
class QueriesConfiguration {

   @ContinuousQuery(..)
   void processCqEvent(CqEvent event) {
       ...
   }
}

@EnableEntityDefinedRegions
@EnableGemfireRepositories
@EnableIndexing
class RepositoriesConfiguration { .. }

虽然对 Spring 框架来说无关紧要,但我们通常建议以可读性为目标,为了将来维护代码的人(将来可能就是你)。

6.18.2. 其他基于配置的注解

以下 SDG 注解在本参考文档中未讨论,原因是该注解支持 Apache Geode 的已弃用功能,或者因为存在更好的替代方法来完成该注解提供的功能

  • @EnableAuth:启用 Apache Geode 的旧身份验证和授权安全模型。(已弃用。Apache Geode 的新集成安全框架可以通过使用 SDG 的 @EnableSecurity 注解在客户端和服务器上启用,如“配置安全”中所述。)

  • @EnableAutoRegionLookup:不推荐。本质上,此注解支持查找在外部配置元数据(如 cache.xml 或应用于服务器的集群配置)中定义的区域,并自动将这些区域注册为 Spring 容器中的 bean。此注解对应于 SDG XML 命名空间中的 <gfe:auto-region-lookup> 元素。更多详细信息可以在 此处 找到。在使用 Spring 和 Spring Data for Apache Geode 时,用户通常应该优先使用 Spring 配置。请参阅“配置区域”和“配置集群配置推送”。

  • @EnableBeanFactoryLocator:启用 SDG GemfireBeanFactoryLocator 功能,此功能仅在使用外部配置元数据(例如,cache.xml)时有用。例如,如果您在 cache.xml 中定义的区域上定义了一个 CacheLoader,您仍然可以使用 Spring 配置中定义的,例如,关系型数据库 DataSource bean 来自动装配此 CacheLoader。此注解利用了此 SDG 功能,如果您有大量遗留配置元数据(例如,cache.xml 文件),则可能会有用。

  • @EnableGemFireAsLastResource:在 全局 - JTA 事务管理 中与 Apache Geode 进行了讨论。

  • @EnableMcast:启用 Apache Geode 的旧对等发现机制,该机制使用基于 UDP 的组播网络。(已弃用。请改用 Apache Geode 定位器。请参阅“配置嵌入式定位器”。

  • @EnableRegionDataAccessTracing:用于调试目的。此注解通过注册一个 AOP 方面来启用对区域执行的所有数据访问操作的跟踪,该方面代理在 Spring 容器中声明为 bean 的所有区域,拦截区域操作并记录事件。

6.19. 结论

正如我们在前面的部分中了解到的,Spring Data for Apache Geode 的新的基于注解的配置模型提供了巨大的力量。希望它能实现其目标,即让您在使用 Apache Geode 与 Spring 时快速入门轻松使用。

请记住,当您使用新的注解时,您仍然可以使用 Java 配置或 XML 配置。您甚至可以通过在 Spring 的 @Configuration@SpringBootApplication 类上使用 Spring 的 @Import@ImportResource 注解来组合所有三种方法。一旦您明确地提供了一个原本由 Spring Data for Apache Geode 使用其中一个注解提供的 bean 定义,基于注解的配置就会退让。

在某些情况下,您甚至可能需要回退到 Java 配置,例如在 Configurers 情况下,以处理更复杂或条件化的配置逻辑,这些逻辑无法通过注解单独表达或无法通过注解实现。不要惊慌。这种行为是预期的。

例如,另一个需要 Java 或 XML 配置的情况是配置 Apache Geode WAN 组件,目前还没有任何注解配置支持。但是,定义和注册 WAN 组件只需要在 Spring 的 @Configuration@SpringBootApplication 类的 Java 配置中使用 org.springframework.data.gemfire.wan.GatewayReceiverFactoryBeanorg.springframework.data.gemfire.wan.GatewaySenderFactoryBean API 类(推荐)。

这些注解并非旨在处理所有情况。这些注解旨在帮助您尽可能快速轻松启动和运行,尤其是在开发过程中。

我们希望您会喜欢这些新功能!

6.20. 基于注解的配置快速入门

以下部分概述了 SDG 注解,以便您快速入门。

所有注解都提供额外的配置属性以及相关的 属性,以便在运行时方便地自定义 Apache Geode 的配置和行为。但是,一般来说,使用特定 Apache Geode 功能不需要任何属性或相关属性。只需声明注解以启用该功能,您就完成了。有关更多详细信息,请参阅每个注解的单独 Javadoc。

6.20.1. 配置 ClientCache 应用程序

要配置和引导 Apache Geode ClientCache 应用程序,请使用以下方法

@SpringBootApplication
@ClientCacheApplication
public class ClientApplication {

  public static void main(String[] args) {
    SpringApplication.run(ClientApplication.class, args);
  }
}

有关更多详细信息,请参阅 使用 Spring 配置 Apache Geode 应用程序

6.20.2. 配置对等 Cache 应用程序

要配置和引导 Apache Geode Peer Cache 应用程序,请使用以下方法

@SpringBootApplication
@PeerCacheApplication
public class ServerApplication {

  public static void main(String[] args) {
    SpringApplication.run(ServerApplication.class, args);
  }
}
如果您想启用一个允许 ClientCache 应用程序连接到此服务器的 CacheServer,只需将 @PeerCacheApplication 注解替换为 @CacheServerApplication 注解。这将启动一个在“localhost”上运行的 CacheServer,监听默认的 CacheServer 端口 40404

有关更多详细信息,请参阅 使用 Spring 配置 Apache Geode 应用程序

6.20.3. 配置嵌入式 Locator

使用 @EnableLocator 注解您的 Spring @PeerCacheApplication@CacheServerApplication 类,以启动一个绑定到所有 NIC 并监听默认 Locator 端口 10334 的嵌入式 Locator,如下所示

@SpringBootApplication
@CacheServerApplication
@EnableLocator
public class ServerApplication {

  public static void main(String[] args) {
    SpringApplication.run(ServerApplication.class, args);
  }
}
@EnableLocator 只能与 Apache Geode 服务器应用程序一起使用。

请参阅 @EnableLocator Javadoc

有关更多详细信息,请参阅 配置嵌入式 Locator

6.20.4. 配置嵌入式 Manager

使用 @EnableManager 注解您的 Spring @PeerCacheApplication@CacheServerApplication 类,以启动一个绑定到所有 NIC 并监听默认 Manager 端口 1099 的嵌入式 Manager,如下所示

@SpringBootApplication
@CacheServerApplication
@EnableManager
public class ServerApplication {

  public static void main(String[] args) {
    SpringApplication.run(ServerApplication.class, args);
  }
}
@EnableManager 只能与 Apache Geode 服务器应用程序一起使用。

请参阅 @EnableManager Javadoc

有关更多详细信息,请参阅 配置嵌入式 Manager

6.20.5. 配置嵌入式 HTTP 服务器

使用 @EnableHttpService 注解您的 Spring @PeerCacheApplication@CacheServerApplication 类,以启动一个监听端口 7070 的嵌入式 HTTP 服务器(Jetty),如下所示

@SpringBootApplication
@CacheServerApplication
@EnableHttpService
public class ServerApplication {

  public static void main(String[] args) {
    SpringApplication.run(ServerApplication.class, args);
  }
}
@EnableHttpService 只能与 Apache Geode 服务器应用程序一起使用。

有关更多详细信息,请参阅 配置嵌入式 HTTP 服务器

6.20.6. 配置嵌入式 Memcached 服务器

在您的 Spring @PeerCacheApplication@CacheServerApplication 类上使用 @EnableMemcachedServer 注解来启动嵌入式 Memcached 服务器(Gemcached),该服务器监听端口 11211,如下所示

@SpringBootApplication
@CacheServerApplication
@EnableMemcachedServer
public class ServerApplication {

  public static void main(String[] args) {
    SpringApplication.run(ServerApplication.class, args);
  }
}
@EnableMemcachedServer 只能与 Apache Geode 服务器应用程序一起使用。

请参阅 配置嵌入式 Memcached 服务器 (Gemcached) 以获取更多详细信息。

6.20.7. 配置嵌入式 Redis 服务器

在您的 Spring @PeerCacheApplication@CacheServerApplication 类上使用 @EnableRedisServer 注解来启动嵌入式 Redis 服务器,该服务器监听端口 6379,如下所示

@SpringBootApplication
@CacheServerApplication
@EnableRedisServer
public class ServerApplication {

  public static void main(String[] args) {
    SpringApplication.run(ServerApplication.class, args);
  }
}
@EnableRedisServer 只能与 Apache Geode 服务器应用程序一起使用。
您必须在 Spring [Boot] 应用程序类路径上显式声明 org.apache.geode:geode-redis 模块。

请参阅 配置嵌入式 Redis 服务器 以获取更多详细信息。

6.20.8. 配置日志记录

要配置或调整 Apache Geode 日志记录,请在您的 Spring、Apache Geode 客户端或服务器应用程序类上使用 @EnableLogging 注解,如下所示

@SpringBootApplication
@ClientCacheApplication
@EnableLogging(logLevel="trace")
public class ClientApplication {

  public static void main(String[] args) {
    SpringApplication.run(ClientApplication.class, args);
  }
}
默认的 log-level 为“config”。此外,此注解不会调整应用程序中的日志级别,仅适用于 Apache Geode。

请参阅 @EnableLogging Javadoc

请参阅 配置日志记录 以获取更多详细信息。

6.20.9. 配置统计信息

要在运行时收集 Apache Geode 统计信息,请在您的 Spring、Apache Geode 客户端或服务器应用程序类上使用 @EnableStatistics 注解,如下所示

@SpringBootApplication
@ClientCacheApplication
@EnableStatistics
public class ClientApplication {

  public static void main(String[] args) {
    SpringApplication.run(ClientApplication.class, args);
  }
}

请参阅 配置统计信息 以获取更多详细信息。

6.20.10. 配置 PDX

要启用 Apache Geode PDX 序列化,请在您的 Spring、Apache Geode 客户端或服务器应用程序类上使用 @EnablePdx 注解,如下所示

@SpringBootApplication
@ClientCacheApplication
@EnablePdx
public class ClientApplication {

  public static void main(String[] args) {
    SpringApplication.run(ClientApplication.class, args);
  }
}
Apache Geode PDX 序列化是 Java 序列化的替代方案,具有许多额外的好处。首先,它简化了使所有应用程序域模型类型可序列化的过程,而无需实现 java.io.Serializable
默认情况下,SDG 会配置 MappingPdxSerializer 来序列化您的应用程序域模型类型,这不需要任何开箱即用的特殊配置来正确识别需要序列化的应用程序域对象,然后执行序列化,因为 MappingPdxSerializer 中的逻辑基于 Spring Data 的映射基础设施。请参阅 MappingPdxSerializer 以获取更多详细信息。

请参阅 @EnablePdx Javadoc

有关更多详细信息,请参阅 配置 PDX

6.20.11. 配置 SSL

要启用 Apache Geode SSL,请使用 @EnableSsl 注释您的 Spring、Apache Geode 客户端或服务器应用程序类,如下所示

@SpringBootApplication
@ClientCacheApplication
@EnableSsl(components = SERVER)
public class ClientApplication {

  public static void main(String[] args) {
    SpringApplication.run(ClientApplication.class, args);
  }
}
至少,Apache Geode 要求您使用适当的配置属性或属性指定密钥库和信任库。密钥库和信任库配置属性或属性都可以引用同一个 KeyStore 文件。此外,如果文件已加密,您需要指定一个用户名和密码来访问 KeyStore 文件。
Apache Geode SSL 允许您配置系统中需要 TLS 的特定组件,例如客户端/服务器、定位器、网关等。可选地,您可以指定 Apache Geode 的所有组件都使用 SSL,方法是使用“ALL”。

请参阅 @EnableSsl Javadoc

有关更多详细信息,请参阅 配置 SSL

6.20.12. 配置安全

要启用 Apache Geode 安全,请使用 @EnableSecurity 注释您的 Spring、Apache Geode 客户端或服务器应用程序类,如下所示

@SpringBootApplication
@ClientCacheApplication
@EnableSecurity
public class ClientApplication {

  public static void main(String[] args) {
    SpringApplication.run(ClientApplication.class, args);
  }
}
在服务器上,您必须配置对身份验证凭据的访问。您可以实现 Apache Geode SecurityManager 接口,也可以声明一个或多个 Apache Shiro Realms。有关更多详细信息,请参阅 配置服务器安全
在客户端上,您必须配置用户名和密码。有关更多详细信息,请参阅 配置客户端安全

有关更多详细信息,请参阅 配置安全

6.20.13. 配置 Apache Geode 属性

要配置其他未被面向功能的 SDG 配置注释覆盖的低级 Apache Geode 属性,请使用 @GemFireProperties 注释您的 Spring、Apache Geode 客户端或服务器应用程序类,如下所示

@SpringBootApplication
@PeerCacheApplication
@EnableGemFireProperties(
    cacheXmlFile = "/path/to/cache.xml",
    conserveSockets = true,
    groups = "GroupOne",
    remoteLocators = "lunchbox[11235],mailbox[10101],skullbox[12480]"
)
public class ServerApplication {

  public static void main(String[] args) {
    SpringApplication.run(ServerApplication.class, args);
  }
}
某些 Apache Geode 属性仅在客户端侧,而其他属性仅在服务器侧。请查看 Apache Geode 文档,了解每个属性的正确用法。

请参阅 配置 Apache Geode 属性,了解更多详细信息。

6.20.14. 配置缓存

要将 Apache Geode 用作 Spring 的 缓存抽象 中的缓存提供程序,并让 SDG 自动为您的应用程序服务组件所需的缓存创建 Apache Geode 区域,请使用 @EnableGemfireCaching@EnableCachingDefinedRegions 注释您的 Spring、Apache Geode 客户端或服务器应用程序类,如下所示

@SpringBootApplication
@ClientCacheApplication
@EnableCachingDefinedRegions
@EnableGemfireCaching
public class ClientApplication {

  public static void main(String[] args) {
    SpringApplication.run(ClientApplication.class, args);
  }
}

然后,只需继续定义需要缓存的应用程序服务,如下所示

@Service
public class BookService {

    @Cacheable("Books")
    public Book findBy(ISBN isbn) {
        ...
    }
}
@EnableCachingDefinedRegions 是可选的。也就是说,您可以根据需要手动定义您的区域。

请参阅 配置 Spring 的缓存抽象,了解更多详细信息。

6.20.15. 为持久性应用程序配置区域、索引、存储库和实体

要简化创建 Spring、Apache Geode 持久性客户端或服务器应用程序的过程,请使用 @EnableEntityDefinedRegions@EnableGemfireRepositories@EnableIndexing 注释您的应用程序类,如下所示

@SpringBootApplication
@ClientCacheApplication
@EnableEntityDefinedRegions(basePackageClasses = Book.class)
@EnableGemfireRepositories(basePackageClasses = BookRepository.class)
@EnableIndexing
public class ClientApplication {

  public static void main(String[] args) {
    SpringApplication.run(ClientApplication.class, args);
  }
}
当使用 @EnableIndexing 注释时,需要 @EnableEntityDefinedRegions 注释。请参阅 配置索引,了解更多详细信息。

接下来,定义您的实体类,并使用 @Region 映射注释指定将存储实体的区域。使用 @Indexed 注释定义用于应用程序查询的实体字段上的索引,如下所示

package example.app.model;

import ...;

@Region("Books")
public class Book {

  @Id
  private ISBN isbn;

  @Indexed;
  private Author author;

  @Indexed
  private LocalDate published;

  @LuceneIndexed
  private String title;

}
@Region("Books") 实体类注解由 @EnableEntityDefinedRegions 用于确定应用程序所需的区域。有关更多详细信息,请参阅 配置类型特定区域POJO 映射

最后,定义您的 CRUD 存储库,使用简单的查询来持久化和访问 Books,如下所示

package example.app.repo;

import ...;

public interface BookRepository extends CrudRepository {

  List<Book> findByAuthorOrderByPublishedDesc(Author author);

}
有关更多详细信息,请参阅 Apache Geode 存储库的 Spring Data

请参阅 @Region Javadoc

请参阅 @Indexed Javadoc

请参阅 @LuceneIndexed Javadoc

有关更多详细信息,请参阅 配置区域

有关更多详细信息,请参阅 Apache Geode 存储库的 Spring Data

6.20.16. 从集群定义的区域配置客户端区域

或者,您可以使用 @EnableClusterDefinedRegions 从集群中已定义的区域定义客户端 [*PROXY] 区域,如下所示

@SpringBootApplication
@ClientCacheApplication
@EnableClusterDefinedRegions
@EnableGemfireRepositories
public class ClientApplication {

  public static void main(String[] args) {
    SpringApplication.run(ClientApplication.class, args);
  }

  ...
}

有关更多详细信息,请参阅 配置的集群定义区域

6.20.17. 配置函数

Apache Geode 函数在分布式计算场景中很有用,在这些场景中,可能需要大量计算才能在集群中的节点上并行执行需要数据的计算。在这种情况下,将逻辑带到数据所在的位置(存储)比请求和获取数据以供计算处理更有效。

使用 @EnableGemfireFunctions 以及 @GemfireFunction 注解来启用作为 POJO 上方法实现的 Apache Geode 函数定义,如下所示

@PeerCacheApplication
@EnableGemfireFunctions
class ServerApplication {

  public static void main(String[] args) {
    SpringApplication.run(ServerApplication.class, args);
  }

  @GemfireFunction
  Integer computeLoyaltyPoints(Customer customer) {
    ...
  }
}

使用 @EnableGemfireFunctionExecutions 以及以下 1 个函数调用注解:@OnMember@OnMembers@OnRegion@OnServer@OnServers

@ClientCacheApplication
@EnableGemfireFunctionExecutions(basePackageClasses = CustomerRewardsFunction.class)
class ClientApplication {

  public static void main(String[] args) {
    SpringApplication.run(ClientApplication.class, args);
  }
}

@OnRegion("Customers")
interface CustomerRewardsFunctions {

  Integer computeLoyaltyPoints(Customer customer);

}

有关更多详细信息,请参阅 函数执行的注释支持

6.20.18. 配置持续查询

实时事件流处理正成为数据密集型应用程序越来越重要的任务,主要目的是及时响应用户请求。Apache Geode 持续查询 (CQ) 将帮助您轻松完成这项相当复杂的任务。

通过使用 @EnableContinuousQueries 注释您的应用程序类来启用 CQ,并定义您的 CQ 以及相关的事件处理程序,如下所示

@ClientCacheApplication
@EnableContinuousQueries
class ClientApplication {

  public static void main(String[] args) {
    SpringApplication.run(ClientApplication.class, args);
  }
}

然后,通过使用 @ContinousQuery 注释相关处理程序方法来定义您的 CQ,如下所示

@Service
class CustomerService {

  @ContinuousQuery(name = "CustomerQuery", query = "SELECT * FROM /Customers c WHERE ...")
  public void process(CqEvent event) {
    ...
  }
}

每当发生事件更改 Customer 数据以匹配您持续 OQL 查询 (CQ) 中的谓词时,都会调用 process 方法。

Apache Geode CQ 仅是客户端功能。

有关更多详细信息,请参阅 持续查询 (CQ)配置持续查询

6.20.19. 配置集群配置

在使用 Apache Geode 作为 Apache Geode ClientCache 应用程序开发 Spring Data 应用程序时,在开发过程中将服务器配置为与客户端在客户端/服务器拓扑中匹配非常有用。实际上,Apache Geode 预计当您在客户端上拥有一个 "/Example" PROXY Region 时,服务器中存在一个名称匹配的 Region(即 "Example")。

您可以使用 Gfsh 创建应用程序所需的每个 Region 和索引,或者,您只需在运行 Spring Data 应用程序使用 Apache Geode 时,将开发应用程序时已表达的配置元数据推送到服务器即可。

这与使用 @EnableClusterConfiguration(..) 注释您的主应用程序类一样简单

使用 @EnableClusterConfiguration
@ClientCacheApplication
@EnableClusterConfiguration(useHttp = true)
class ClientApplication {
  ...
}
大多数情况下,在使用客户端/服务器拓扑结构时,特别是在生产环境中,集群的服务器将使用Gfsh启动。在这种情况下,通常使用 HTTP(S) 将配置元数据(例如区域和索引定义)发送到集群。当使用 HTTP 时,配置元数据将发送到集群中的管理器,并在集群中的服务器节点之间一致地分发。
为了使用@EnableClusterConfiguration,您必须在 Spring 应用程序类路径中声明org.springframework:spring-web依赖项。

有关更多详细信息,请参阅配置集群配置推送

6.20.20. 配置GatewayReceivers

不同 Apache Geode 集群之间的数据复制是一种越来越重要的容错和高可用性 (HA) 机制。Apache Geode WAN 复制是一种机制,允许一个 Apache Geode 集群以可靠且容错的方式将其数据复制到另一个 Apache Geode 集群。

Apache Geode WAN 复制需要配置两个组件

  • GatewayReceiver - 从远程 Apache Geode 集群的GatewaySender接收数据的 WAN 复制组件。

  • GatewaySender - 将数据发送到远程 Apache Geode 集群的GatewayReceiver的 WAN 复制组件。

要启用GatewayReceiver,应用程序类需要使用@EnableGatewayReceiver进行注释,如下所示

@CacheServerApplication
@EnableGatewayReceiver(manualStart = false, startPort = 10000, endPort = 11000, maximumTimeBetweenPings = 1000,
    socketBufferSize = 16384, bindAddress = "localhost",transportFilters = {"transportBean1", "transportBean2"},
    hostnameForSenders = "hostnameLocalhost"){
      ...
      ...
    }
}
class MySpringApplication { .. }
Apache Geode GatewayReceiver仅是服务器端功能,只能在CacheServer或对等Cache节点上配置。

6.20.21. 配置GatewaySenders

要启用GatewaySender,应用程序类需要使用@EnableGatewaySenders@EnableGatewaySender进行注释,如下所示

@CacheServerApplication
@EnableGatewaySenders(gatewaySenders = {
		@EnableGatewaySender(name = "GatewaySender", manualStart = true,
			remoteDistributedSystemId = 2, diskSynchronous = true, batchConflationEnabled = true,
			parallel = true, persistent = false,diskStoreReference = "someDiskStore",
			orderPolicy = OrderPolicyType.PARTITION, alertThreshold = 1234, batchSize = 100,
			eventFilters = "SomeEventFilter", batchTimeInterval = 2000, dispatcherThreads = 22,
			maximumQueueMemory = 400,socketBufferSize = 16384,
			socketReadTimeout = 4000, regions = { "Region1"}),
		@EnableGatewaySender(name = "GatewaySender2", manualStart = true,
			remoteDistributedSystemId = 2, diskSynchronous = true, batchConflationEnabled = true,
			parallel = true, persistent = false, diskStoreReference = "someDiskStore",
			orderPolicy = OrderPolicyType.PARTITION, alertThreshold = 1234, batchSize = 100,
			eventFilters = "SomeEventFilter", batchTimeInterval = 2000, dispatcherThreads = 22,
			maximumQueueMemory = 400, socketBufferSize = 16384,socketReadTimeout = 4000,
			regions = { "Region2" })
}){
class MySpringApplication { .. }
}
Apache Geode GatewaySender仅是服务器端功能,只能在CacheServer或对等Cache节点上配置。

在上面的示例中,应用程序配置了 2 个区域,Region1Region2。此外,将配置两个GatewaySenders来为这两个区域提供服务。GatewaySender1将被配置为复制Region1的数据,而GatewaySender2将被配置为复制Region2的数据。

如上所示,每个GatewaySender属性都可以在每个EnableGatewaySender注释上配置。

也可以使用更通用的“默认”属性方法,其中所有属性都在EnableGatewaySenders注释上配置。这样,可以在父注释上设置一组通用的默认值,然后根据需要在子注释上覆盖,如下所示

@CacheServerApplication
@EnableGatewaySenders(gatewaySenders = {
		@EnableGatewaySender(name = "GatewaySender", transportFilters = "transportBean1", regions = "Region2"),
		@EnableGatewaySender(name = "GatewaySender2")},
		manualStart = true, remoteDistributedSystemId = 2,
		diskSynchronous = false, batchConflationEnabled = true, parallel = true, persistent = true,
		diskStoreReference = "someDiskStore", orderPolicy = OrderPolicyType.PARTITION, alertThreshold = 1234, batchSize = 1002,
		eventFilters = "SomeEventFilter", batchTimeInterval = 2000, dispatcherThreads = 22, maximumQueueMemory = 400,
		socketBufferSize = 16384, socketReadTimeout = 4000, regions = { "Region1", "Region2" },
		transportFilters = { "transportBean2", "transportBean1" })
class MySpringApplication { .. }
regions属性为空或未填充时,GatewaySender(s) 将自动附加到应用程序中配置的每个Region

7. 使用 Apache Geode API

一旦 Apache Geode 缓存和区域配置完成,它们就可以被注入并在应用程序对象中使用。本章描述了与 Spring 事务管理功能和 DAO 异常层次结构的集成。本章还涵盖了对 Apache Geode 管理对象的依赖注入的支持。

7.1. GemfireTemplate

与 Spring 提供的许多其他高级抽象一样,Spring Data for Apache Geode 提供了一个模板来简化 Apache Geode 数据访问操作。该类提供了包含常见区域操作的几种方法,但也提供了使用GemfireCallback对原生 Apache Geode API 执行代码的能力,而无需处理 Apache Geode 检查异常。

模板类需要一个 Apache Geode Region,并且一旦配置完成,它就是线程安全的,可以在多个应用程序类中重复使用。

<bean id="gemfireTemplate" class="org.springframework.data.gemfire.GemfireTemplate" p:region-ref="SomeRegion"/>

一旦模板配置完成,开发人员就可以将它与GemfireCallback一起使用,直接与 Apache Geode Region 交互,而无需处理检查异常、线程或资源管理问题。

template.execute(new GemfireCallback<Iterable<String>>() {

	public Iterable<String> doInGemfire(Region region)
	        throws GemFireCheckedException, GemFireException {

		Region<String, String> localRegion = (Region<String, String>) region;

		localRegion.put("1", "one");
		localRegion.put("3", "three");

		return localRegion.query("length < 5");
	}
});

为了访问 Apache Geode 查询语言的全部功能,开发人员可以使用findfindUnique方法,与query方法相比,它们可以跨多个区域执行查询、执行投影等等。

当查询选择多个项目(通过SelectResults)时,应使用find方法,而当仅返回一个对象时,应使用findUnique方法,顾名思义。

7.2. 异常转换

使用新的数据访问技术不仅需要适应新的 API,还需要处理特定于该技术的异常。

为了适应异常处理情况,Spring 框架提供了一个与技术无关且一致的异常层次结构,它将应用程序从专有且通常是“检查”的异常抽象到一组集中的运行时异常。

Spring 框架文档中所述,异常转换可以通过使用@Repository注释和 AOP 透明地应用于您的数据访问对象 (DAO),方法是定义一个PersistenceExceptionTranslationPostProcessor bean。只要声明了CacheFactoryBean(例如,使用<gfe:cache/><gfe:client-cache>声明),使用 Apache Geode 时就会启用相同的异常转换功能,它充当异常转换器,并由 Spring 基础设施自动检测并相应地使用。

7.3. 本地缓存事务管理

Spring 框架最受欢迎的功能之一是事务管理

如果您不熟悉 Spring 的事务抽象,那么我们强烈建议您阅读有关Spring 事务管理基础设施的信息,因为它提供了一个一致的编程模型,该模型在多个 API 上透明地工作,并且可以通过编程方式或声明方式(最受欢迎的选择)进行配置。

对于 Apache Geode,Spring Data for Apache Geode 提供了一个专用的、针对每个缓存的 PlatformTransactionManager,一旦声明,就可以通过 Spring 原子地执行 Region 操作。

使用 XML 启用事务管理
<gfe:transaction-manager id="txManager" cache-ref="myCache"/>
如果 Apache Geode 缓存是在默认名称 gemfireCache 下定义的,则上面的示例可以通过消除 cache-ref 属性来进一步简化。与其他 Spring Data for Apache Geode 命名空间元素一样,如果缓存 bean 名称未配置,则将使用上述命名约定。此外,如果未显式指定,事务管理器名称为“gemfireTransactionManager”。

目前,Apache Geode 支持具有 **读已提交** 隔离级别的乐观事务。此外,为了保证这种隔离级别,开发人员应避免进行手动修改缓存中值的 **就地** 更改。为了防止这种情况发生,事务管理器默认情况下将缓存配置为使用 **复制到读取** 语义,这意味着每次执行读取操作时都会创建实际值的克隆。如果需要,可以通过 copyOnRead 属性禁用此行为。

由于在启用 **复制到读取** 时会为给定键的值制作副本,因此您必须随后调用 Region.put(key, value) 才能以事务方式更新该值。

有关底层 Geode 事务管理器的语义和行为的更多信息,请参阅 Geode CacheTransactionManager Javadoc 以及 文档

7.4. 全局 JTA 事务管理

Apache Geode 也可以参与全局 JTA 基于事务,例如由 Java EE 应用服务器(例如 WebSphere Application Server (WAS))使用容器管理事务 (CMT) 以及其他 JTA 资源管理的事务。

但是,与许多其他 JTA “兼容” 资源(例如 ActiveMQ 等 JMS 消息代理)不同,Apache Geode **不是** XA 兼容资源。因此,Apache Geode 必须在 JTA 事务(准备阶段)中被定位为“最后一个资源”,因为它没有实现两阶段提交协议,或者更确切地说,它不处理分布式事务。

许多能够进行 CMT 的管理环境都支持 JTA 基于事务中的“最后一个资源”非 XA 兼容资源,尽管 JTA 规范中实际上并不需要。有关非 XA 兼容“最后一个资源”的更多信息,请参阅 Red Hat 的 文档。事实上,Red Hat 的 JBoss 项目 Narayana 就是这样一个 LGPL 开源实现。Narayana 将此称为“最后一个资源提交优化”(LRCO)。更多详细信息可以在这里找到 这里

无论您是在使用 Apache Geode 的独立环境中,使用支持“Last Resource”的开源 JTA 事务管理实现,还是在受管环境(例如 WAS 等 Java EE AS)中,Spring Data for Apache Geode 都能满足您的需求。

要将 Apache Geode 正确地用作涉及多个事务资源的 JTA 事务中的“Last Resource”,您必须完成一系列步骤。此外,此类安排中只能有一个非 XA 兼容资源(例如 Apache Geode)。

1) 首先,您必须完成 Apache Geode 文档中的步骤 1-4 此处

上面的步骤 #1 与您的 Spring [Boot] 和/或 [Data for Apache Geode] 应用程序无关,必须成功完成。

2) 参考 Apache Geode 文档中的步骤 5 此处,当使用 @EnableGemFireAsLastResource 注解时,Spring Data for Apache Geode 的注解支持将尝试为您设置 GemFireCachecopyOnRead 属性。

但是,如果 SDG 的自动配置在这方面不成功,那么您必须在 <gfe:cache><gfe:client-cache> XML 元素中显式设置 copy-on-read 属性,或者在 JavaConfig 中将 CacheFactoryBean 类的 copyOnRead 属性设置为 true。例如

ClientCache XML

使用 XML 设置 copy-on-read(客户端)
<gfe:client-cache ... copy-on-read="true"/>

ClientCache JavaConfig

使用 JavaConfig 设置 copyOnRead(客户端)
@Bean
ClientCacheFactoryBean gemfireCache() {

  ClientCacheFactoryBean gemfireCache = new ClientCacheFactoryBean();

  gemfireCache.setCopyOnRead(true);

  return gemfireCache;
}

对等 Cache XML

使用 XML 设置 copy-on-read(服务器)
<gfe:cache ... copy-on-read="true"/>

对等 Cache JavaConfig

使用 JavaConfig 设置 copyOnRead(服务器)
@Bean
CacheFactoryBean gemfireCache() {

  CacheFactoryBean gemfireCache = new CacheFactoryBean();

  gemfireCache.setCopyOnRead(true);

  return gemfireCache;
}
显式设置 copy-on-read 属性或 copyOnRead 属性实际上没有必要。启用事务管理会处理读取时的复制。

3) 在此阶段,您跳过 Apache Geode 文档中的步骤 6-8 此处,并让Spring Data Geode发挥其魔力。您只需使用 Spring Data for Apache Geode 的 @EnableGemFireAsLastResource 注解来注解您的 Spring @Configuration 类,Spring 的 事务管理 基础设施和 Spring Data for Apache Geode 的 @EnableGemFireAsLastResource 注解配置的组合即可完成此操作。

配置如下…​

@Configuration
@EnableGemFireAsLastResource
@EnableTransactionManagement(order = 1)
class GeodeConfiguration {
  ...
}

唯一的要求是…​

3.1) @EnableGemFireAsLastResource 注解必须声明在与 Spring 的 @EnableTransactionManagement 注解相同的 Spring @Configuration 类上。

3.2) @EnableTransactionManagement 注解的 order 属性必须显式设置为非 Integer.MAX_VALUEInteger.MIN_VALUE 的整数值(默认为 Integer.MAX_VALUE)。

当然,希望您知道,在使用 JTA 事务时,您还需要配置 Spring 的 JtaTransactionManager,如下所示。

@Bean
public JtaTransactionManager transactionManager(UserTransaction userTransaction) {

   JtaTransactionManager transactionManager = new JtaTransactionManager();

   transactionManager.setUserTransaction(userTransaction);

   return transactionManager;
}
本地、缓存事务管理 部分中的配置适用于此。使用 Spring Data for Apache Geode 的 GemfireTransactionManager 适用于“仅本地”缓存事务,适用于“全局”JTA 事务。因此,在这种情况下,您需要配置 SDG GemfireTransactionManager。您需要配置 Spring 的 JtaTransactionManager,如上所示。

有关使用Spring 的事务管理与 JTA 的更多详细信息,请参见 此处

实际上,Spring Data for Apache Geode 的 @EnableGemFireAsLastResource 注解会导入包含 2 个 Aspect Bean 定义的配置,这些定义在事务操作期间的适当点处理 Apache Geode 的 o.a.g.ra.GFConnectionFactory.getConnection()o.a.g.ra.GFConnection.close() 操作。

具体来说,事件的正确顺序如下

  1. jtaTransation.begin()

  2. GFConnectionFactory.getConnection()

  3. 调用应用程序的 @Transactional 服务方法

  4. jtaTransaction.commit()jtaTransaction.rollback()

  5. 最后,GFConnection.close()

这与您(作为应用程序开发人员)在必须自己使用 JTA API + Apache Geode API 时手动编写代码的方式一致,如 Apache Geode 示例 中所示。

值得庆幸的是,Spring 为您完成了繁重的工作,您所需要做的就是在应用了适当的配置(如上所示)之后

将服务方法声明为 @Transactional
@Service
class MyTransactionalService {

  @Transactional
  public <Return-Type> someTransactionalServiceMethod() {
    // perform business logic interacting with and accessing multiple JTA resources atomically
  }

  ...
}

上面的 #1 和 #4 由 Spring 的基于 JTA 的 PlatformTransactionManager 在您的应用程序进入 @Transactional 边界时(即当调用 MyTransactionService.someTransactionalServiceMethod() 时)为您适当地处理。

#2 和 #3 由 Spring Data for Apache Geode 的使用 @EnableGemFireAsLastResource 注解启用的新 Aspect 处理。

当然,#3 是您应用程序的责任。

实际上,在配置了适当的日志记录后,您将看到事件的正确顺序…

事务日志输出
2017-Jun-22 11:11:37 TRACE TransactionInterceptor - Getting transaction for [example.app.service.MessageService.send]

2017-Jun-22 11:11:37 TRACE GemFireAsLastResourceConnectionAcquiringAspect - Acquiring {data-store-name} Connection
from {data-store-name} JCA ResourceAdapter registered at [gfe/jca]

2017-Jun-22 11:11:37 TRACE MessageService - PRODUCER [ Message :
[{ @type = example.app.domain.Message, id= MSG0000000000, message = SENT }],
JSON : [{"id":"MSG0000000000","message":"SENT"}] ]

2017-Jun-22 11:11:37 TRACE TransactionInterceptor - Completing transaction for [example.app.service.MessageService.send]

2017-Jun-22 11:11:37 TRACE GemFireAsLastResourceConnectionClosingAspect - Closed {data-store-name} Connection @ [Reference [...]]

有关使用 Apache Geode 缓存级事务的更多详细信息,请参见 此处

有关在 JTA 事务中使用 Apache Geode 的更多详细信息,请参见 此处

有关将 Apache Geode 配置为“最后资源”的更多详细信息,请参见 此处

7.5. 使用 @TransactionalEventListener

在使用事务时,可能需要注册一个监听器,以便在事务提交之前或之后,或在回滚发生后执行某些操作。

Spring Data for Apache Geode 使得创建监听器变得容易,这些监听器将在使用@TransactionalEventListener 注释的特定事务阶段被调用。使用@TransactionalEventListener 注释的方法(如下所示)将在指定phase 期间,从事务方法发布的事件中收到通知。

事务提交后事件监听器
@TransactionalEventListener(phase = TransactionPhase.AFTER_COMMIT)
public void handleAfterCommit(MyEvent event) {
    // do something after transaction is committed
}

为了调用上述方法,您必须在事务中发布一个事件,如下所示

发布事务事件
@Service
class MyTransactionalService {

  @Autowired
  private final ApplicationEventPublisher applicationEventPublisher;

  @Transactional
  public <Return-Type> someTransactionalServiceMethod() {

    // Perform business logic interacting with and accessing multiple transactional resources atomically, then...

    applicationEventPublisher.publishEvent(new MyApplicationEvent(...));
  }

  ...
}

@TransactionalEventListener 注释允许您指定事件处理程序方法将被调用的事务phase。选项包括:AFTER_COMMITAFTER_COMPLETIONAFTER_ROLLBACKBEFORE_COMMIT。如果未指定,phase 默认值为 AFTER_COMMIT。如果您希望即使在没有事务的情况下也调用监听器,您可以将fallbackExecution 设置为 true

7.6. 自动事务事件发布

从 Spring Data for Apache Geode Neumann/2.3 开始,现在可以启用自动事务事件发布。

使用@EnableGemfireCacheTransactions 注释,将enableAutoTransactionEventPublishing 属性设置为 true。默认值为 false

启用自动事务事件发布
@EnableGemfireCacheTransactions(enableAutoTransactionEventPublishing = true)
class GeodeConfiguration { ... }

然后,您可以创建@TransactionalEventListener 注释的 POJO 方法来处理AFTER_COMMITAFTER_ROLLBACK 事务阶段的事务事件。

@Component
class TransactionEventListeners {

	@TransactionalEventListener(phase = TransactionPhase.AFTER_COMMIT)
	public void handleAfterCommit(TransactionApplicationEvent event) {
		...
	}

	@TransactionalEventListener(phase = TransactionPhase.AFTER_ROLLBACK)
	public void handleAfterRollback(TransactionApplicationEvent event) {
		...
	}
}
仅支持TransactionPhase.AFTER_COMMITTransactionPhase.AFTER_ROLLBACK。不支持 TransactionPhase.BEFORE_COMMIT,因为 1) SDG 采用 Apache Geode 的 TransactionListenerTransactionWriter 接口来实现自动事务事件发布,以及 2) 当 Apache Geode 的 TransactionWriter.beforeCommit(:TransactionEvent) 被调用时,它已经在 AbstractPlatformTransactionManager.triggerBeforeCommit(:TransactionStatus) 调用之后,在该调用中,@TranactionalEventListener 注释的 POJO 方法在事务生命周期中被调用。

使用自动事务事件发布,您不需要在应用程序@Transactional @Service 方法中显式调用applicationEventPublisher.publishEvent(..) 方法。

但是,如果您仍然希望在“提交之前”接收事务事件,那么您仍然必须在应用程序@Transactional @Service 方法中调用applicationEventPublisher.publishEvent(..) 方法。有关更多详细信息,请参见上面的注意

7.7. 连续查询 (CQ)

Apache Geode 提供的一个强大功能是 连续查询 (或 CQ)。

简而言之,CQ 允许开发人员创建和注册一个 OQL 查询,然后在添加到 Apache Geode 的新数据与查询谓词匹配时自动收到通知。Spring Data for Apache Geode 通过org.springframework.data.gemfire.listener 包及其监听器容器提供对 CQ 的专用支持;在功能和命名方面与Spring 框架中的 JMS 集成非常相似;事实上,熟悉 Spring 中 JMS 支持的用户应该会感到宾至如归。

基本上,Spring Data for Apache Geode 允许 POJO 上的方法成为 CQ 的端点。只需定义查询并指定应在匹配时调用以接收通知的方法。Spring Data for Apache Geode 会处理其余事宜。这与 Java EE 的消息驱动 Bean 风格非常相似,但无需任何基于 Apache Geode 的基类或接口实现。

目前,持续查询仅在 Apache Geode 的客户端/服务器拓扑中受支持。此外,使用的客户端池需要启用订阅。有关更多信息,请参阅 Apache Geode 文档

7.7.1. 持续查询监听器容器

Spring Data for Apache Geode 通过使用 SDG 的 ContinuousQueryListenerContainer 简化了 CQ 事件的创建、注册、生命周期和分发,该容器负责 CQ 周围的基础设施,并为用户完成所有繁重的工作。熟悉 EJB 和 JMS 的用户应该会发现这些概念很熟悉,因为它被设计得尽可能接近 Spring 框架 中提供的支持,以及其消息驱动 POJO (MDP)。

SDG ContinuousQueryListenerContainer 充当事件(或消息)监听器容器;它用于接收来自已注册 CQ 的事件,并调用注入到其中的 POJO。监听器容器负责所有消息接收的线程处理,并将消息分发到监听器进行处理。它充当 EDP(事件驱动 POJO)和事件提供者之间的中介,并负责 CQ 的创建和注册(以接收事件)、资源获取和释放、异常转换等。这使您作为应用程序开发人员能够编写与接收事件(并对其做出反应)相关的(可能很复杂)业务逻辑,并将样板 Apache Geode 基础设施问题委托给框架。

监听器容器是完全可定制的。开发人员可以选择使用 CQ 线程执行调度(同步传递),或者通过定义合适的 `java.util.concurrent.Executor`(或 Spring 的 `TaskExecutor`)使用新线程(来自现有池)来实现异步方法。根据负载、监听器数量或运行时环境,开发人员应该更改或调整执行器以更好地满足其需求。特别是,在托管环境(例如应用程序服务器)中,强烈建议选择合适的 `TaskExecutor` 以利用其运行时。

7.7.2. `ContinuousQueryListener` 和 `ContinuousQueryListenerAdapter`

`ContinuousQueryListenerAdapter` 类是 Spring Data for Apache Geode CQ 支持的最终组件。简而言之,该类允许您将几乎 **任何** 实现类作为 EDP 公开,而无需太多限制。`ContinuousQueryListenerAdapter` 实现 `ContinuousQueryListener` 接口,这是一个简单的监听器接口,类似于 Apache Geode 的 CqListener

考虑以下接口定义。注意各种事件处理方法及其参数

public interface EventDelegate {
     void handleEvent(CqEvent event);
     void handleEvent(Operation baseOp);
     void handleEvent(Object key);
     void handleEvent(Object key, Object newValue);
     void handleEvent(Throwable throwable);
     void handleQuery(CqQuery cq);
     void handleEvent(CqEvent event, Operation baseOp, byte[] deltaValue);
     void handleEvent(CqEvent event, Operation baseOp, Operation queryOp, Object key, Object newValue);
}
package example;

class DefaultEventDelegate implements EventDelegate {
    // implementation elided for clarity...
}

特别要注意,上面 `EventDelegate` 接口的实现 **没有** 任何 Apache Geode 依赖项。它确实是一个 POJO,我们可以通过以下配置将其转换为 EDP。

该类不必实现接口;接口仅用于更好地展示契约和实现之间的解耦。
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:gfe="https://www.springframework.org/schema/geode"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="
    http://www.springframework.org/schema/beans https://www.springframework.org/schema/beans/spring-beans.xsd
    https://www.springframework.org/schema/geode https://www.springframework.org/schema/geode/spring-geode.xsd
">

	<gfe:client-cache/>

	<gfe:pool subscription-enabled="true">
	   <gfe:server host="localhost" port="40404"/>
	</gfe:pool>

	<gfe:cq-listener-container>
	   <!-- default handle method -->
	   <gfe:listener ref="listener" query="SELECT * FROM /SomeRegion"/>
	   <gfe:listener ref="another-listener" query="SELECT * FROM /AnotherRegion" name="myQuery" method="handleQuery"/>
	</gfe:cq-listener-container>

	<bean id="listener" class="example.DefaultMessageDelegate"/>
	<bean id="another-listener" class="example.DefaultMessageDelegate"/>
  ...
<beans>
上面的示例展示了监听器可以具有的几种不同形式;在最少的情况下,需要监听器引用和实际查询定义。但是,可以为生成的连续查询指定一个名称(用于监控),还可以指定方法的名称(默认值为 `handleEvent`)。指定的方法可以具有各种参数类型,`EventDelegate` 接口列出了允许的类型。

上面的示例使用 Spring Data for Apache Geode 命名空间来声明事件监听器容器并自动注册监听器。完整的 **bean** 定义如下所示

<!-- this is the Event Driven POJO (MDP) -->
<bean id="eventListener" class="org.springframework.data.gemfire.listener.adapter.ContinuousQueryListenerAdapter">
    <constructor-arg>
        <bean class="gemfireexample.DefaultEventDelegate"/>
    </constructor-arg>
</bean>

<!-- and this is the event listener container... -->
<bean id="gemfireListenerContainer" class="org.springframework.data.gemfire.listener.ContinuousQueryListenerContainer">
    <property name="cache" ref="gemfireCache"/>
    <property name="queryListeners">
      <!-- set of CQ listeners -->
      <set>
        <bean class="org.springframework.data.gemfire.listener.ContinuousQueryDefinition" >
               <constructor-arg value="SELECT * FROM /SomeRegion" />
               <constructor-arg ref="eventListener"/>
        </bean>
      </set>
    </property>
</bean>

每次收到事件时,适配器都会自动在 Apache Geode 事件和所需方法参数之间进行类型转换。方法调用引起的任何异常都会被容器捕获并处理(默认情况下,会记录异常)。

7.8. 连接 `Declarable` 组件

Apache Geode XML 配置(通常称为 `cache.xml`)允许将 **用户** 对象声明为配置的一部分。通常这些对象是 `CacheLoaders` 或 Apache Geode 支持的其他可插拔回调组件。使用原生 Apache Geode 配置,通过 XML 声明的每个用户类型都必须实现 `Declarable` 接口,该接口允许通过 `Properties` 实例将任意参数传递给声明的类。

在本节中,我们将描述如何在使用 Spring 时配置这些可插拔组件,这些组件在 cache.xml 中定义,同时保持您的缓存/区域配置在 cache.xml 中定义。这允许您的可插拔组件专注于应用程序逻辑,而不是 DataSources 或其他协作者的位置或创建。

但是,如果您要启动一个全新项目,建议您直接在 Spring 中配置缓存、区域和其他可插拔的 Apache Geode 组件。这避免了从本节中介绍的 Declarable 接口或基类继承。

有关此方法的更多信息,请参见以下侧边栏。

消除 Declarable 组件

开发人员可以完全通过 Spring 配置自定义类型,如 配置区域 中所述。这样,开发人员就不必实现 Declarable 接口,并且还可以从 Spring IoC 容器的所有功能中受益(不仅仅是依赖注入,还有生命周期和实例管理)。

以下声明(取自 Declarable Javadoc)是使用 Spring 配置 Declarable 组件的示例。

<cache-loader>
   <class-name>com.company.app.DBLoader</class-name>
   <parameter name="URL">
     <string>jdbc://12.34.56.78/mydb</string>
   </parameter>
</cache-loader>

为了简化解析、转换参数和初始化对象的步骤,Spring Data for Apache Geode 提供了一个基类(WiringDeclarableSupport),它允许通过 **模板** bean 定义来连接 Apache Geode 用户对象,或者在缺少模板 bean 定义的情况下,通过 Spring IoC 容器进行自动连接。为了利用此功能,用户对象需要扩展 WiringDeclarableSupport,它会自动定位声明的 BeanFactory 并在初始化过程中执行连接。

为什么需要基类?

在当前的 Apache Geode 版本中,没有 **对象工厂** 的概念,声明的类型按原样实例化和使用。换句话说,没有简单的方法来管理 Apache Geode 之外的对象创建。

7.8.1. 使用 **模板** bean 定义进行配置

当使用 WiringDeclarableSupport 时,它会首先尝试定位现有的 bean 定义并将其用作连接模板。除非指定,否则组件类名将用作隐式 bean 定义名称。

让我们看看在这种情况下我们的DBLoader声明会是什么样子

class DBLoader extends WiringDeclarableSupport implements CacheLoader {

  private DataSource dataSource;

  public void setDataSource(DataSource dataSource){
    this.dataSource = dataSource;
  }

  public Object load(LoaderHelper helper) { ... }
}
<cache-loader>
   <class-name>com.company.app.DBLoader</class-name>
   <!-- no parameter is passed (use the bean's implicit name, which is the class name) -->
</cache-loader>
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:p="http://www.springframework.org/schema/p"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="
    http://www.springframework.org/schema/beans https://www.springframework.org/schema/beans/spring-beans.xsd
">

  <bean id="dataSource" ... />

  <!-- template bean definition -->
  <bean id="com.company.app.DBLoader" abstract="true" p:dataSource-ref="dataSource"/>
</beans>

在上面的场景中,由于没有指定参数,因此使用 ID/名称为com.company.app.DBLoader的 bean 作为模板来连接 Apache Geode 创建的实例。对于 bean 名称使用不同约定的情况,可以在 Apache Geode 配置中传入bean-name参数

<cache-loader>
   <class-name>com.company.app.DBLoader</class-name>
   <!-- pass the bean definition template name as parameter -->
   <parameter name="bean-name">
     <string>template-bean</string>
   </parameter>
</cache-loader>
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:p="http://www.springframework.org/schema/p"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="
    http://www.springframework.org/schema/beans https://www.springframework.org/schema/beans/spring-beans.xsd
">

  <bean id="dataSource" ... />

   <!-- template bean definition -->
   <bean id="template-bean" abstract="true" p:dataSource-ref="dataSource"/>

</beans>
模板 bean 定义不必在 XML 中声明。任何格式都是允许的(Groovy、注释等)。

7.8.2. 使用自动连接和注释进行配置

默认情况下,如果找不到 bean 定义,WiringDeclarableSupport自动连接声明的实例。这意味着,除非实例提供任何依赖注入元数据,否则容器将找到对象的 setter 并尝试自动满足这些依赖项。但是,开发人员也可以使用 JDK 5 注释为自动连接过程提供更多信息。

我们强烈建议阅读 Spring 文档中专门针对章节,以获取有关支持的注释和启用因素的更多信息。

例如,上面的假设DBLoader声明可以通过以下方式注入 Spring 配置的DataSource

class DBLoader extends WiringDeclarableSupport implements CacheLoader {

  // use annotations to 'mark' the needed dependencies
  @javax.inject.Inject
  private DataSource dataSource;

  public Object load(LoaderHelper helper) { ... }
}
<cache-loader>
   <class-name>com.company.app.DBLoader</class-name>
   <!-- no need to declare any parameters since the class is auto-wired -->
</cache-loader>
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="
    http://www.springframework.org/schema/beans https://www.springframework.org/schema/beans/spring-beans.xsd
    http://www.springframework.org/schema/context https://www.springframework.org/schema/context/spring-context.xsd
">

     <!-- enable annotation processing -->
     <context:annotation-config/>

</beans>

通过使用 JSR-330 注释,CacheLoader 代码已简化,因为DataSource 的位置和创建已外部化,用户代码只关注加载过程。DataSource 可能是事务性的,延迟创建的,在多个对象之间共享的,或者从 JNDI 中检索的。这些方面可以通过 Spring 容器轻松配置和更改,而无需触及DBLoader代码。

7.9. 对 Spring 缓存抽象的支持

Spring Data for Apache Geode 提供了 Spring 缓存抽象 的实现,将 Apache Geode 定位为 Spring 缓存基础设施中的缓存提供者

要使用 Apache Geode 作为支持实现,即 Spring 缓存抽象中的“缓存提供者”,只需将GemfireCacheManager添加到您的配置中

<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:cache="http://www.springframework.org/schema/cache"
       xmlns:gfe="https://www.springframework.org/schema/geode"
       xmlns:p="http://www.springframework.org/schema/p"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="
    http://www.springframework.org/schema/beans https://www.springframework.org/schema/beans/spring-beans.xsd
    http://www.springframework.org/schema/cache https://www.springframework.org/schema/cache/spring-cache.xsd
    https://www.springframework.org/schema/geode https://www.springframework.org/schema/geode/spring-geode.xsd
">

  <!-- enable declarative caching -->
  <cache:annotation-driven/>

  <gfe:cache id="gemfire-cache"/>

  <!-- declare GemfireCacheManager; must have a bean ID of 'cacheManager' -->
  <bean id="cacheManager" class="org.springframework.data.gemfire.cache.GemfireCacheManager"
      p:cache-ref="gemfire-cache">

</beans>
如果使用默认缓存 bean 名称(即“gemfireCache”),即<gfe:cache>没有显式 ID,则CacheManager bean 定义上的cache-ref属性不是必需的。

GemfireCacheManager(单例)bean 实例被声明并且声明式缓存被启用(在 XML 中使用<cache:annotation-driven/>或在 JavaConfig 中使用 Spring 的@EnableCaching注释),Spring 缓存注释(例如@Cacheable)标识将使用 Apache Geode 区域在内存中缓存数据的“缓存”。

这些缓存(即区域)必须在使用它们的缓存注解之前存在,否则会发生错误。

例如,假设您有一个客户服务应用程序,其中包含一个执行缓存的 CustomerService 应用程序组件……

@Service
class CustomerService {

@Cacheable(cacheNames="Accounts", key="#customer.id")
Account createAccount(Customer customer) {
  ...
}

那么您将需要以下配置。

XML

<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:cache="http://www.springframework.org/schema/cache"
       xmlns:gfe="https://www.springframework.org/schema/geode"
       xmlns:p="http://www.springframework.org/schema/p"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="
    http://www.springframework.org/schema/beans https://www.springframework.org/schema/beans/spring-beans.xsd
    http://www.springframework.org/schema/cache https://www.springframework.org/schema/cache/spring-cache.xsd
    https://www.springframework.org/schema/geode https://www.springframework.org/schema/geode/spring-geode.xsd
">

  <!-- enable declarative caching -->
  <cache:annotation-driven/>

  <bean id="cacheManager" class="org.springframework.data.gemfire.cache.GemfireCacheManager">

  <gfe:cache/>

  <gfe:partitioned-region id="accountsRegion" name="Accounts" persistent="true" ...>
    ...
  </gfe:partitioned-region>
</beans>

JavaConfig

@Configuration
@EnableCaching
class ApplicationConfiguration {

  @Bean
  CacheFactoryBean gemfireCache() {
    return new CacheFactoryBean();
  }

  @Bean
  GemfireCacheManager cacheManager() {
    GemfireCacheManager cacheManager = GemfireCacheManager();
    cacheManager.setCache(gemfireCache());
    return cacheManager;
  }

  @Bean("Accounts")
  PartitionedRegionFactoryBean accountsRegion() {
    PartitionedRegionFactoryBean accounts = new PartitionedRegionFactoryBean();

    accounts.setCache(gemfireCache());
    accounts.setClose(false);
    accounts.setPersistent(true);

    return accounts;
  }
}

当然,您可以自由选择任何您喜欢的区域类型(例如 REPLICATE、PARTITION、LOCAL 等)。

有关Spring 的缓存抽象的更多详细信息,请再次参考文档

8. 使用 Apache Geode 序列化

为了提高 Apache Geode 内存数据网格的整体性能,Apache Geode 支持一种专用的序列化协议,称为 PDX,它比标准 Java 序列化更快,并提供更紧凑的结果,此外它还可以在各种语言平台(Java、C++ 和 .NET)上透明地工作。

有关更多详细信息,请参阅PDX 序列化功能PDX 序列化内部机制

本章讨论 Spring Data for Apache Geode 简化和改进 Apache Geode 在 Java 中的自定义序列化的各种方法。

8.1. 连接反序列化实例

序列化对象通常具有瞬态数据。瞬态数据通常取决于系统或其在特定时间点所在的运行环境。例如,DataSource 是特定于环境的。序列化此类信息毫无用处,甚至可能很危险,因为它特定于某个 VM 或机器。对于这种情况,Spring Data for Apache Geode 提供了一个特殊的 Instantiator,它在反序列化期间为 Apache Geode 创建的每个新实例执行连接。

通过这种机制,您可以依赖 Spring 容器来注入和管理某些依赖项,从而轻松地将瞬态数据与持久数据分离,并在透明的方式下拥有丰富的域对象。

Spring 用户可能会发现这种方法类似于 @Configurable)。WiringInstantiator 的工作原理类似于 WiringDeclarableSupport,首先尝试找到一个 bean 定义作为连接模板,否则回退到自动连接。

有关连接功能的更多详细信息,请参阅上一节(连接 Declarable 组件)。

要使用 SDG Instantiator,请将其声明为一个 bean,如下例所示

<bean id="instantiator" class="org.springframework.data.gemfire.serialization.WiringInstantiator">
  <!-- DataSerializable type -->
  <constructor-arg>org.pkg.SomeDataSerializableClass</constructor-arg>
  <!-- type id -->
  <constructor-arg>95</constructor-arg>
</bean>

在 Spring 容器启动期间,一旦它被初始化,Instantiator 默认情况下会将自身注册到 Apache Geode 序列化系统,并在 Apache Geode 在反序列化期间创建的所有 SomeDataSerializableClass 实例上执行连接。

8.2. 自动生成自定义 Instantiators

对于数据密集型应用程序,随着数据的流入,每台机器上可能会创建大量实例。Apache Geode 使用反射来创建新类型,但对于某些场景,这可能会证明是昂贵的。与往常一样,最好进行性能分析以量化这是否属实。对于这种情况,Spring Data for Apache Geode 允许自动生成 Instatiator 类,这些类实例化一个新类型(使用默认构造函数),而无需使用反射。以下示例展示了如何创建实例化器

<bean id="instantiatorFactory" class="org.springframework.data.gemfire.serialization.InstantiatorFactoryBean">
  <property name="customTypes">
    <map>
      <entry key="org.pkg.CustomTypeA" value="1025"/>
      <entry key="org.pkg.CustomTypeB" value="1026"/>
    </map>
  </property>
</bean>

前面的定义自动为两个类(CustomTypeACustomTypeB)生成两个 Instantiators,并在用户 ID 10251026 下将它们注册到 Apache Geode。这两个 Instantiators 避免使用反射,并通过 Java 代码直接创建实例。

9. POJO 映射

本节涵盖

9.1. 对象映射基础

本节涵盖 Spring Data 对象映射的基础知识,包括对象创建、字段和属性访问、可变性和不可变性。请注意,本节仅适用于不使用底层数据存储的对象映射的 Spring Data 模块(如 JPA)。此外,请务必查阅特定于存储的章节,了解特定于存储的对象映射,例如索引、自定义列或字段名称等。

Spring Data 对象映射的核心职责是创建域对象的实例,并将存储本机数据结构映射到这些实例上。这意味着我们需要两个基本步骤

  1. 使用公开的构造函数之一创建实例。

  2. 实例填充,以实现所有公开的属性。

9.1.1. 对象创建

Spring Data 会自动尝试检测持久实体的构造函数,以用于实现该类型对象。解析算法的工作原理如下

  1. 如果存在一个用@PersistenceCreator注解的静态工厂方法,则使用它。

  2. 如果存在一个构造函数,则使用它。

  3. 如果存在多个构造函数,并且只有一个用@PersistenceCreator注解,则使用它。

  4. 如果存在无参数构造函数,则使用它。其他构造函数将被忽略。

值解析假设构造函数/工厂方法参数名称与实体的属性名称匹配,即解析将像填充属性一样执行,包括映射中的所有自定义(不同的数据存储列或字段名称等)。这也需要在类文件中提供参数名称信息,或者在构造函数上存在@ConstructorProperties注解。

可以使用 Spring Framework 的@Value 值注解使用特定于存储的 SpEL 表达式来自定义值解析。有关更多详细信息,请参阅特定于存储的映射部分。

对象创建内部机制

为了避免反射带来的开销,Spring Data 对象创建默认情况下使用在运行时生成的工厂类,该工厂类将直接调用域类的构造函数。例如,对于以下示例类型

class Person {
  Person(String firstname, String lastname) { … }
}

我们将在运行时创建一个语义上等效于以下工厂类的工厂类

class PersonObjectInstantiator implements ObjectInstantiator {

  Object newInstance(Object... args) {
    return new Person((String) args[0], (String) args[1]);
  }
}

这使我们比反射获得了大约 10% 的性能提升。为了使域类有资格进行这种优化,它需要遵守一组约束

  • 它不能是私有类

  • 它不能是非静态内部类

  • 它不能是 CGLib 代理类

  • Spring Data 要使用的构造函数不能是私有的

如果满足上述任何条件,Spring Data 将回退到通过反射实例化实体。

9.1.2. 属性填充

一旦创建了实体实例,Spring Data 将填充该类所有剩余的持久属性。除非实体的构造函数已经填充(即通过其构造函数参数列表使用),否则将首先填充标识符属性,以允许解析循环对象引用。之后,所有非瞬态属性(尚未由构造函数填充)都将设置在实体实例上。为此,我们使用以下算法

  1. 如果属性是不可变的,但公开了一个with…方法(见下文),我们将使用with…方法创建一个具有新属性值的新实体实例。

  2. 如果定义了属性访问(即通过 getter 和 setter 访问),我们将调用 setter 方法。

  3. 如果属性是可变的,我们直接设置字段。

  4. 如果属性是不可变的,我们使用构造函数,该构造函数将被持久化操作使用(参见 对象创建)来创建实例的副本。

  5. 默认情况下,我们直接设置字段值。

属性填充内部机制

与我们在 对象构造中的优化 类似,我们也使用 Spring Data 运行时生成的访问器类来与实体实例交互。

class Person {

  private final Long id;
  private String firstname;
  private @AccessType(Type.PROPERTY) String lastname;

  Person() {
    this.id = null;
  }

  Person(Long id, String firstname, String lastname) {
    // Field assignments
  }

  Person withId(Long id) {
    return new Person(id, this.firstname, this.lastame);
  }

  void setLastname(String lastname) {
    this.lastname = lastname;
  }
}
示例 1. 生成的属性访问器
class PersonPropertyAccessor implements PersistentPropertyAccessor {

  private static final MethodHandle firstname;              (2)

  private Person person;                                    (1)

  public void setProperty(PersistentProperty property, Object value) {

    String name = property.getName();

    if ("firstname".equals(name)) {
      firstname.invoke(person, (String) value);             (2)
    } else if ("id".equals(name)) {
      this.person = person.withId((Long) value);            (3)
    } else if ("lastname".equals(name)) {
      this.person.setLastname((String) value);              (4)
    }
  }
}
1 PropertyAccessor 持有底层对象的可变实例。这是为了能够对原本不可变的属性进行修改。
2 默认情况下,Spring Data 使用字段访问来读取和写入属性值。根据 `private` 字段的可见性规则,`MethodHandles` 用于与字段交互。
3 该类公开了一个 `withId(…)` 方法,用于设置标识符,例如,当实例被插入到数据存储中并且生成了标识符时。调用 `withId(…)` 会创建一个新的 `Person` 对象。所有后续的修改都将在新实例中进行,而不会影响之前的实例。
4 使用属性访问允许直接调用方法,而无需使用 `MethodHandles`。

这使我们比反射获得了大约 25% 的性能提升。为了使域类有资格进行这种优化,它需要满足一组约束。

  • 类型不能位于默认包或 `java` 包下。

  • 类型及其构造函数必须是 `public` 的。

  • 作为内部类的类型必须是 `static` 的。

  • 使用的 Java 运行时必须允许在源 `ClassLoader` 中声明类。Java 9 及更高版本会施加某些限制。

默认情况下,Spring Data 尝试使用生成的属性访问器,如果检测到限制,则回退到基于反射的访问器。

让我们看一下以下实体。

示例 2. 一个示例实体
class Person {

  private final @Id Long id;                                                (1)
  private final String firstname, lastname;                                 (2)
  private final LocalDate birthday;
  private final int age;                                                    (3)

  private String comment;                                                   (4)
  private @AccessType(Type.PROPERTY) String remarks;                        (5)

  static Person of(String firstname, String lastname, LocalDate birthday) { (6)

    return new Person(null, firstname, lastname, birthday,
      Period.between(birthday, LocalDate.now()).getYears());
  }

  Person(Long id, String firstname, String lastname, LocalDate birthday, int age) { (6)

    this.id = id;
    this.firstname = firstname;
    this.lastname = lastname;
    this.birthday = birthday;
    this.age = age;
  }

  Person withId(Long id) {                                                  (1)
    return new Person(id, this.firstname, this.lastname, this.birthday, this.age);
  }

  void setRemarks(String remarks) {                                         (5)
    this.remarks = remarks;
  }
}
1 标识符属性是最终的,但在构造函数中设置为 `null`。该类公开了一个 `withId(…)` 方法,用于设置标识符,例如,当实例被插入到数据存储中并且生成了标识符时。原始的 `Person` 实例保持不变,因为创建了一个新的实例。相同的模式通常应用于其他存储管理的属性,但可能需要为持久化操作进行更改。with 方法是可选的,因为持久化构造函数(参见 6)实际上是一个复制构造函数,设置属性将转换为创建具有应用的新标识符值的全新实例。
2 `firstname` 和 `lastname` 属性是普通的不可变属性,可能通过 getter 公开。
3 age 属性是不可变的,但它是从 birthday 属性派生的。在所示的设计中,数据库值将胜过默认值,因为 Spring Data 使用唯一声明的构造函数。即使意图是优先考虑计算,但重要的是,此构造函数也应将 age 作为参数(以可能忽略它),否则属性填充步骤将尝试设置 age 字段并由于它是不可变的并且没有 with… 方法而失败。
4 comment 属性是可变的,通过直接设置其字段来填充。
5 remarks 属性是可变的,通过调用 setter 方法来填充。
6 该类公开了一个工厂方法和一个构造函数来创建对象。这里的主要思想是使用工厂方法而不是额外的构造函数,以避免通过 @PersistenceCreator 进行构造函数歧义。相反,属性的默认值在工厂方法中处理。如果希望 Spring Data 使用工厂方法进行对象实例化,请使用 @PersistenceCreator 对其进行注释。

9.1.3. 一般建议

  • 尝试坚持使用不可变对象 — 不可变对象易于创建,因为实现对象只需调用其构造函数即可。此外,这避免了您的域对象充斥着 setter 方法,这些方法允许客户端代码操作对象状态。如果您需要这些方法,请优先将其设为包保护,以便它们只能被有限数量的同位类型调用。仅构造函数实现比属性填充快 30%。

  • 提供一个全参数构造函数 — 即使您不能或不想将您的实体建模为不可变值,提供一个将实体的所有属性(包括可变属性)作为参数的构造函数仍然有价值,因为这允许对象映射跳过属性填充以实现最佳性能。

  • 使用工厂方法而不是重载构造函数来避免 @PersistenceCreator — 由于需要全参数构造函数来实现最佳性能,我们通常希望公开更多特定于应用程序用例的构造函数,这些构造函数省略了诸如自动生成的标识符等内容。使用静态工厂方法来公开这些全参数构造函数的变体是一种既定的模式。

  • 确保您遵守允许使用生成的实例化器和属性访问器类的约束 — 

  • 对于要生成的标识符,仍然使用最终字段与全参数持久化构造函数(首选)或 with… 方法结合使用 — 

  • 使用 Lombok 避免样板代码 — 由于持久化操作通常需要一个包含所有参数的构造函数,它们的声明变成了对样板参数到字段赋值的乏味重复,而 Lombok 的 @AllArgsConstructor 可以最好地避免这种情况。

覆盖属性

Java 允许灵活设计域类,其中子类可以定义一个与其超类中已声明的同名属性。考虑以下示例

public class SuperType {

   private CharSequence field;

   public SuperType(CharSequence field) {
      this.field = field;
   }

   public CharSequence getField() {
      return this.field;
   }

   public void setField(CharSequence field) {
      this.field = field;
   }
}

public class SubType extends SuperType {

   private String field;

   public SubType(String field) {
      super(field);
      this.field = field;
   }

   @Override
   public String getField() {
      return this.field;
   }

   public void setField(String field) {
      this.field = field;

      // optional
      super.setField(field);
   }
}

这两个类都使用可赋值类型定义了一个 field。然而,SubType 隐藏了 SuperType.field。根据类设计,使用构造函数可能是设置 SuperType.field 的唯一默认方法。或者,在 setter 中调用 super.setField(…) 可以设置 SuperType 中的 field。所有这些机制在某种程度上都会产生冲突,因为属性具有相同的名称,但可能代表两个不同的值。如果类型不可赋值,Spring Data 会跳过超类型属性。也就是说,覆盖属性的类型必须可赋值给其超类型属性类型才能被注册为覆盖,否则超类型属性将被视为瞬态。我们通常建议使用不同的属性名称。

Spring Data 模块通常支持包含不同值的覆盖属性。从编程模型的角度来看,需要考虑以下几点

  1. 应该持久化哪个属性(默认情况下为所有声明的属性)?您可以通过使用 @Transient 注解来排除属性。

  2. 如何在数据存储中表示属性?对不同值使用相同的字段/列名通常会导致数据损坏,因此您应该使用显式字段/列名对至少一个属性进行注解。

  3. 无法使用 @AccessType(PROPERTY),因为在不进行任何关于 setter 实现的进一步假设的情况下,无法普遍设置超属性。

9.1.4. Kotlin 支持

Spring Data 调整了 Kotlin 的具体细节,以允许对象创建和变异。

Kotlin 对象创建

支持实例化 Kotlin 类,所有类默认情况下都是不可变的,并且需要显式属性声明来定义可变属性。考虑以下 dataPerson

data class Person(val id: String, val name: String)

上面的类编译成一个具有显式构造函数的典型类。我们可以通过添加另一个构造函数并使用 @PersistenceCreator 注解它来定制此类,以指示构造函数的优先级

data class Person(var id: String, val name: String) {

    @PersistenceCreator
    constructor(id: String) : this(id, "unknown")
}

Kotlin 支持参数可选性,允许在未提供参数时使用默认值。当 Spring Data 检测到具有参数默认值的构造函数时,如果数据存储不提供值(或只是返回 null),则它会省略这些参数,以便 Kotlin 可以应用参数默认值。考虑以下对 name 应用参数默认值的类

data class Person(var id: String, val name: String = "unknown")

每次 name 参数不是结果的一部分或其值为 null 时,name 都会默认为 unknown

Kotlin 数据类的属性填充

在 Kotlin 中,所有类默认情况下都是不可变的,并且需要显式属性声明来定义可变属性。考虑以下 dataPerson

data class Person(val id: String, val name: String)

此类实际上是不可变的。它允许创建新实例,因为 Kotlin 生成一个 copy(…) 方法,该方法创建新的对象实例,复制现有对象的所有属性值,并应用作为方法参数提供的属性值。

Kotlin 重写属性

Kotlin 允许声明 属性重写 以更改子类中的属性。

open class SuperType(open var field: Int)

class SubType(override var field: Int = 1) :
	SuperType(field) {
}

这种安排会生成两个名为 field 的属性。Kotlin 为每个类中的每个属性生成属性访问器(getter 和 setter)。实际上,代码看起来如下

public class SuperType {

   private int field;

   public SuperType(int field) {
      this.field = field;
   }

   public int getField() {
      return this.field;
   }

   public void setField(int field) {
      this.field = field;
   }
}

public final class SubType extends SuperType {

   private int field;

   public SubType(int field) {
      super(field);
      this.field = field;
   }

   public int getField() {
      return this.field;
   }

   public void setField(int field) {
      this.field = field;
   }
}

SubType 上的 getter 和 setter 仅设置 SubType.field,而不是 SuperType.field。在这种安排中,使用构造函数是设置 SuperType.field 的唯一默认方法。向 SubType 添加一个方法来通过 this.SuperType.field = … 设置 SuperType.field 是可能的,但这超出了支持的约定。属性重写会在一定程度上造成冲突,因为属性共享相同的名称,但可能代表两个不同的值。我们通常建议使用不同的属性名称。

Spring Data 模块通常支持包含不同值的覆盖属性。从编程模型的角度来看,需要考虑以下几点

  1. 应该持久化哪个属性(默认情况下为所有声明的属性)?您可以通过使用 @Transient 注解来排除属性。

  2. 如何在数据存储中表示属性?对不同值使用相同的字段/列名通常会导致数据损坏,因此您应该使用显式字段/列名对至少一个属性进行注解。

  3. 由于无法设置超属性,因此无法使用 @AccessType(PROPERTY)

9.2. 实体映射

Spring Data for Apache Geode 提供了对映射存储在 Region 中的实体的支持。映射元数据通过在应用程序域类上使用注释来定义,如下面的示例所示

示例 3. 将域类映射到 Apache Geode Region
@Region("People")
public class Person {

  @Id Long id;

  String firstname;
  String lastname;

  @PersistenceConstructor
  public Person(String firstname, String lastname) {
    // …
  }

  …
}

@Region 注释可用于自定义存储 Person 类实例的 Region。@Id 注释可用于注释用作缓存 Region 密钥的属性,标识 Region 条目。@PersistenceConstructor 注释有助于区分多个可能可用的构造函数,这些构造函数接受参数并明确标记注释为构造函数的构造函数,该构造函数用于构建实体。在没有或只有一个构造函数的应用程序域类中,您可以省略注释。

除了将实体存储在顶级 Region 中之外,还可以将实体存储在子 Region 中,如下面的示例所示

@Region("/Users/Admin")
public class Admin extends User {
  …
}

@Region("/Users/Guest")
public class Guest extends User {
  …
}

请确保使用 Apache Geode Region 的完整路径,该路径由 Spring Data for Apache Geode XML 命名空间定义,使用 <*-region> 元素的 idname 属性。

9.2.1. 按 Region 类型映射实体

除了 @Region 注解之外,Spring Data for Apache Geode 还识别特定于类型的 Region 映射注解:@ClientRegion@LocalRegion@PartitionRegion@ReplicateRegion

在功能上,这些注解在 SDG 映射基础设施中与通用 @Region 注解的处理方式完全相同。但是,这些额外的映射注解在 Spring Data for Apache Geode 的注解配置模型中很有用。当与 Spring @Configuration 注解类上的 @EnableEntityDefinedRegions 配置注解结合使用时,可以在本地缓存中生成 Region,无论应用程序是客户端还是对等方。

这些注解可以让您更具体地指定应用程序实体类应该映射到的 Region 类型,并且还会影响 Region 的数据管理策略(例如,分区(也称为分片)与复制数据)。

使用这些特定于类型的 Region 映射注解与 SDG 注解配置模型,可以避免您在配置中显式定义这些 Region。

9.3. 存储库映射

作为在实体类上使用 @Region 注解来指定存储实体的 Region 的替代方法,您也可以在实体的 Repository 接口上指定 @Region 注解。有关更多详细信息,请参见 Spring Data for Apache Geode 存储库

但是,假设您想将 Person 记录存储在多个 Apache Geode Region 中(例如,PeopleCustomers)。然后,您可以定义相应的 Repository 接口扩展,如下所示

@Region("People")
public interface PersonRepository extends GemfireRepository<Person, String> {
…
}

@Region("Customers")
public interface CustomerRepository extends GemfireRepository<Person, String> {
...
}

然后,使用每个存储库,您可以将实体存储在多个 Apache Geode Region 中,如下面的示例所示

@Service
class CustomerService {

  CustomerRepository customerRepo;

  PersonRepository personRepo;

  Customer update(Customer customer) {
    customerRepo.save(customer);
    personRepo.save(customer);
    return customer;
  }

您甚至可以将 update 服务方法包装在 Spring 管理的事务中,无论是本地缓存事务还是全局事务。

9.4. MappingPdxSerializer

Spring Data for Apache Geode 提供了一个自定义的 PdxSerializer 实现,称为 MappingPdxSerializer,它使用 Spring Data 映射元数据来定制实体序列化。

序列化器还允许您通过使用 Spring Data 的 EntityInstantiator 抽象来定制实体实例化。默认情况下,序列化器使用 ReflectionEntityInstantiator,它使用映射实体的持久化构造函数。持久化构造函数可以是默认构造函数、单个声明的构造函数或显式用 @PersistenceConstructor 注解的构造函数。

为了为构造函数参数提供参数,序列化器从提供的 PdxReader 中读取具有命名构造函数参数的字段,这些字段通过使用 Spring 的 @Value 注解显式标识,如下例所示

示例 4. 在实体构造函数参数上使用 @Value
public class Person {

  public Person(@Value("#root.thing") String firstName, @Value("bean") String lastName) {
    …
  }
}

以这种方式进行注解的实体类将从 PdxReader 中读取“thing”字段,并将其作为构造函数参数 firstname 的参数值传递。lastName 的值是一个名为“bean”的 Spring bean。

除了 EntityInstantiators 提供的自定义实例化逻辑和策略之外,MappingPdxSerializer 还提供了远远超出 Apache Geode 自身的 ReflectionBasedAutoSerializer 的功能。

虽然 Apache Geode 的 ReflectionBasedAutoSerializer 方便地使用 Java 反射来填充实体,并使用正则表达式来识别应由序列化器处理(序列化和反序列化)的类型,但它不像 MappingPdxSerializer 那样可以执行以下操作

  • 根据实体字段或属性名称和类型注册自定义 PdxSerializer 对象。

  • 方便地识别 ID 属性。

  • 自动处理只读属性。

  • 自动处理瞬态属性。

  • 允许以更健壮的方式进行类型过滤,以确保类型安全(例如,不限于仅使用正则表达式来表达类型)。

现在,我们将更详细地探讨 MappingPdxSerializer 的每个功能。

9.4.1. 自定义 PdxSerializer 注册

MappingPdxSerializer 使您能够根据实体的字段或属性名称和类型注册自定义 PdxSerializers

例如,假设您已定义一个实体类型来建模 User,如下所示

package example.app.security.auth.model;

public class User {

  private String name;

  private Password password;

  ...
}

虽然用户的姓名可能不需要任何特殊的逻辑来序列化值,但另一方面,序列化密码可能需要额外的逻辑来处理该字段或属性的敏感性。

您可能希望在通过网络(客户端和服务器之间)发送值时,除了 TLS 之外,还要保护密码,并且您只想存储加盐的哈希值。当使用 MappingPdxSerializer 时,您可以注册一个自定义的 PdxSerializer 来处理用户的密码,如下所示

示例 5. 通过 POJO 字段/属性类型注册自定义 PdxSerializers
Map<?, PdxSerializer> customPdxSerializers = new HashMap<>();

customPdxSerializers.put(Password.class, new SaltedHashPasswordPdxSerializer());

mappingPdxSerializer.setCustomPdxSerializers(customPdxSerializers);

在将应用程序定义的 SaltedHashPasswordPdxSerializer 实例与 Password 应用程序域模型类型注册后,MappingPdxSerializer 将会查询自定义的 PdxSerializer 来序列化和反序列化所有 Password 对象,无论包含的对象是什么(例如,User)。

但是,假设您只想在 User 对象上自定义 Passwords 的序列化。为此,您可以通过指定 Class 字段或属性的完全限定名称来注册 User 类型的自定义 PdxSerializer,如下面的示例所示

示例 6. 通过 POJO 字段/属性名称注册自定义 PdxSerializers
Map<?, PdxSerializer> customPdxSerializers = new HashMap<>();

customPdxSerializers.put("example.app.security.auth.model.User.password", new SaltedHashPasswordPdxSerializer());

mappingPdxSerializer.setCustomPdxSerializers(customPdxSerializers);

请注意使用完全限定的字段或属性名称(即 example.app.security.auth.model.User.password)作为自定义 PdxSerializer 注册键。

您可以使用更逻辑的代码片段来构建注册键,例如以下代码:User.class.getName().concat(".password");。我们建议您使用这种方法,而不是前面示例中显示的方法。前面的示例试图尽可能明确地说明注册的语义。

9.4.2. 映射 ID 属性

与 Apache Geode 的 ReflectionBasedAutoSerializer 一样,SDG 的 MappingPdxSerializer 也能够确定实体的标识符。但是,MappingPdxSerializer 通过使用 Spring Data 的映射元数据来实现这一点,具体来说,是通过使用 Spring Data 的 @Id 注解来查找被指定为标识符的实体属性。或者,任何名为“id”且未显式使用 @Id 注解的字段或属性也被指定为实体的标识符。

例如

class Customer {

  @Id
  Long id;

  ...
}

在这种情况下,Customerid 字段通过使用 PdxWriter.markIdentifierField(:String) 在 PDX 类型元数据中被标记为标识符字段,当在序列化期间调用 PdxSerializer.toData(..) 方法时。

9.4.3. 映射只读属性

当您的实体定义了一个只读属性时会发生什么?

首先,了解“只读”属性是什么非常重要。如果您按照 JavaBeans 规范(如 Spring 所做的那样)定义 POJO,您可能会定义一个具有只读属性的 POJO,如下所示

package example;

class ApplicationDomainType {

  private AnotherType readOnly;

  public AnotherType getReadOnly() [
    this.readOnly;
  }

  ...
}

readOnly 属性是只读的,因为它没有提供 setter 方法。它只有 getter 方法。在这种情况下,readOnly 属性(不要与 readOnly DomainType 字段混淆)被认为是只读的。

因此,MappingPdxSerializer 在反序列化期间,在 PdxSerializer.fromData(:Class<ApplicationDomainType>, :PdxReader) 方法中填充 ApplicationDomainType 实例时,不会尝试为该属性设置值,特别是如果 PDX 序列化字节中存在值。

这在您可能返回某个实体类型的视图或投影,并且您只想设置可写状态的情况下很有用。也许实体的视图或投影是基于授权或其他标准。重点是,您可以根据应用程序的用例和需求利用此功能。如果您希望字段或属性始终被写入,只需定义一个 setter 方法。

9.4.4. 映射瞬态属性

同样,当您的实体定义 transient 属性时会发生什么?

您会期望实体的 transient 字段或属性在序列化实体时不会被序列化为 PDX。这正是发生的情况,与 Apache Geode 自己的 ReflectionBasedAutoSerializer 不同,后者会序列化通过 Java 反射从对象访问的所有内容。

MappingPdxSerializer 不会序列化任何被限定为瞬态的字段或属性,无论是使用 Java 自己的 transient 关键字(在类实例字段的情况下)还是使用 @Transient Spring Data 注解在字段或属性上。

例如,您可以定义一个具有瞬态字段和属性的实体,如下所示

package example;

class Process {

  private transient int id;

  private File workingDirectory;

  private String name;

  private Type type;

  @Transient
  public String getHostname() {
    ...
  }

  ...
}

Process id 字段和可读的 hostname 属性都不会写入 PDX。

9.4.5. 按类类型过滤

与 Apache Geode 的 ReflectionBasedAutoSerializer 类似,SDG 的 MappingPdxSerializer 允许您过滤序列化和反序列化的对象类型。

但是,与 Apache Geode 的 ReflectionBasedAutoSerializer 使用复杂的正则表达式来表达序列化器处理的类型不同,SDG 的 MappingPdxSerializer 使用更强大的 java.util.function.Predicate 接口和 API 来表达类型匹配标准。

如果您想使用正则表达式,可以使用 Java 的 正则表达式支持 实现 Predicate

Java 的 Predicate 接口的优点是,您可以使用方便且合适的 API 方法组合 Predicates,包括:and(:Predicate)or(:Predicate)negate()

以下示例展示了 Predicate API 的实际应用

Predicate<Class<?>> customerTypes =
  type -> Customer.class.getPackage().getName().startsWith(type.getName()); // Include all types in the same package as `Customer`

Predicate includedTypes = customerTypes
  .or(type -> User.class.isAssignble(type)); // Additionally, include User sub-types (e.g. Admin, Guest, etc)

mappingPdxSerializer.setIncludeTypeFilters(includedTypes);

mappingPdxSerializer.setExcludeTypeFilters(
  type -> !Reference.class.getPackage(type.getPackage()); // Exclude Reference types
传递给您的 Predicate 的任何 Class 对象都保证不为 null

SDG 的 MappingPdxSerializer 包含对包含和排除类类型过滤器的支持。

排除类型过滤

默认情况下,SDG 的 MappingPdxSerializer 注册预定义的 Predicates,这些 Predicates 过滤或排除以下包中的类型

  • java.*

  • com.gemstone.gemfire.*

  • org.apache.geode.*

  • org.springframework.*

此外,MappingPdxSerializer 在调用 PdxSerializer.toData(:Object, :PdxWriter) 时过滤 null 对象,在调用 PdxSerializer.fromData(:Class<?>, :PdxReader) 方法时过滤 null 类类型。

通过简单地定义一个 Predicate 并将其添加到 MappingPdxSerializer 中,就像前面展示的那样,很容易为其他类类型或整个包类型添加排除项。

MappingPdxSerializer.setExcludeTypeFilters(:Predicate<Class<?>>) 方法是累加的,这意味着它使用 Predicate.and(:Predicate<Class<?>>) 方法将您的应用程序定义的类型过滤器与上面指示的现有预定义类型过滤器 Predicates 组合起来。

但是,如果您想包含一个类类型(例如,java.security Principal),而该类类型被排除类型过滤器隐式排除,请参阅 包含类型过滤

包含类型过滤

如果您想显式包含一个类类型,或覆盖一个隐式排除应用程序所需类类型的类类型过滤器(例如,java.security.Principal,它默认情况下被 MappingPdxSerializer 上的 java.* 包排除类型过滤器排除),那么只需定义相应的 Predicate 并使用 MappingPdxSerializer.setIncludeTypeFilters(:Predicate<Class<?>>) 方法将其添加到序列化器中,如下所示

Predicate<Class<?>> principalTypeFilter =
  type -> java.security.Principal.class.isAssignableFrom(type);

mappingPdxSerializer.setIncludeTypeFilters(principalTypeFilters);

同样,MappingPdxSerializer.setIncludeTypeFilters(:Predicate<Class<?>>) 方法与 setExcludeTypeFilters(:Predicate<Class<?>>) 一样,是累加的,因此使用 Predicate.or(:Predicate<Class<?>>) 组合任何传递的类型过滤器。这意味着您可以根据需要多次调用 setIncludeTypeFilters(:Predicate<Class<?>>)

当存在包含类型过滤器时,MappingPdxSerializer 会根据以下条件决定是否对某个类类型的实例进行序列化或反序列化:该类类型既未被隐式排除,又明确包含,或者两者都返回 true。然后,该类类型的实例将被适当地序列化或反序列化。

例如,当一个类型过滤器 Predicate<Class<Principal>> 被明确注册时,如前所述,它会取消对 java.* 包类型隐式排除类型过滤器的作用。

10. Spring Data for Apache Geode 仓库

Spring Data for Apache Geode 支持使用 Spring Data 仓库抽象,以便轻松地将实体持久化到 Apache Geode 中,并执行查询。有关仓库编程模型的总体介绍,请参阅 此处

10.1. Spring XML 配置

要引导 Spring Data 仓库,请使用 Spring Data for Apache Geode 数据命名空间中的 <repositories/> 元素,如下例所示

示例 7. 在 XML 中引导 Spring Data for Apache Geode 仓库
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:gfe-data="https://www.springframework.org/schema/data/geode"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="
    http://www.springframework.org/schema/beans https://www.springframework.org/schema/beans/spring-beans.xsd
    https://www.springframework.org/schema/data/geode https://www.springframework.org/schema/data/geode/spring-data-geode.xsd
">

  <gfe-data:repositories base-package="com.example.acme.repository"/>

</beans>

上述配置片段会在配置的基包下查找接口,并为这些接口创建仓库实例,这些实例由 SimpleGemFireRepository 支持。

除非您已将应用程序域类正确映射到配置的区域,否则引导过程将失败。

10.2. Spring 基于 Java 的配置

或者,许多开发人员更喜欢使用 Spring 的 基于 Java 的容器配置

使用这种方法,您可以通过使用 SDG 的 @EnableGemfireRepositories 注解来引导 Spring Data 仓库,如下例所示

示例 8. 使用 @EnableGemfireRepositories 引导 Spring Data for Apache Geode 仓库
@SpringBootApplication
@EnableGemfireRepositories(basePackages = "com.example.acme.repository")
class SpringDataApplication {
  ...
}

您可能更喜欢使用类型安全的 basePackageClasses 属性,而不是使用 basePackages 属性。basePackageClasses 允许您通过仅指定一个应用程序仓库接口类型来指定包含所有应用程序仓库类的包。考虑在每个包中创建一个特殊的无操作标记类或接口,除了标识此属性引用的应用程序仓库的位置之外,它没有任何其他用途。

除了 basePackagesbasePackageClasses 属性之外,与 Spring 的 @ComponentScan 注解类似,@EnableGemfireRepositories 注解还提供基于 Spring 的 ComponentScan.Filter 类型的包含和排除过滤器。您可以使用 filterType 属性根据不同的方面进行过滤,例如应用程序仓库类型是否使用特定注解进行注释,或者是否扩展特定类类型等等。有关更多详细信息,请参阅 FilterType Javadoc

@EnableGemfireRepositories 注解还允许您使用 namedQueriesLocation 属性指定命名 OQL 查询的位置,这些查询位于 Java Properties 文件中。属性名称必须与仓库查询方法的名称匹配,属性值是您希望在调用仓库查询方法时执行的 OQL 查询。

如果您的应用程序需要一个或多个 自定义仓库实现,则可以将 repositoryImplementationPostfix 属性设置为备用值(默认为 Impl)。此功能通常用于扩展 Spring Data 仓库基础设施来实现数据存储(例如 SDG)未提供的功能。

在使用 Apache Geode 时,自定义存储库实现的一个例子是在执行联接时。SDG 存储库不支持联接。对于 Apache Geode 的 PARTITION 区域,联接必须在共置的 PARTITION 区域上执行,因为 Apache Geode 不支持“分布式”联接。此外,等值联接 OQL 查询必须在 Apache Geode 函数内执行。有关 Apache Geode *等值联接查询* 的更多详细信息,请参阅 此处

SDG 的存储库基础设施扩展的许多其他方面也可以自定义。有关所有配置设置的更多详细信息,请参阅 @EnableGemfireRepositories Javadoc。

10.3. 执行 OQL 查询

Spring Data for Apache Geode 存储库允许定义查询方法,以轻松地对托管实体映射到的区域执行 Apache Geode OQL 查询,如下面的示例所示

示例 9. 示例存储库
@Region("People")
public class Person { … }
public interface PersonRepository extends CrudRepository<Person, Long> {

  Person findByEmailAddress(String emailAddress);

  Collection<Person> findByFirstname(String firstname);

  @Query("SELECT * FROM /People p WHERE p.firstname = $1")
  Collection<Person> findByFirstnameAnnotated(String firstname);

  @Query("SELECT * FROM /People p WHERE p.firstname IN SET $1")
  Collection<Person> findByFirstnamesAnnotated(Collection<String> firstnames);
}

前面的示例中列出的第一个查询方法会导致以下 OQL 查询被派生:SELECT x FROM /People x WHERE x.emailAddress = $1。第二个查询方法的工作方式相同,只是它返回找到的所有实体,而第一个查询方法期望找到单个结果。

如果支持的关键字不足以声明和表达您的 OQL 查询,或者方法名称变得过于冗长,那么您可以使用 @Query 注释查询方法,如第三和第四个方法所示。

下表提供了您可以用在查询方法中的支持关键字的简要示例

表 4. 查询方法支持的关键字
关键字 示例 逻辑结果

GreaterThan

findByAgeGreaterThan(int age)

x.age > $1

GreaterThanEqual

findByAgeGreaterThanEqual(int age)

x.age >= $1

LessThan

findByAgeLessThan(int age)

x.age < $1

LessThanEqual

findByAgeLessThanEqual(int age)

x.age ⇐ $1

IsNotNull, NotNull

findByFirstnameNotNull()

x.firstname =! NULL

IsNull, Null

findByFirstnameNull()

x.firstname = NULL

In

findByFirstnameIn(Collection<String> x)

x.firstname IN SET $1

NotIn

findByFirstnameNotIn(Collection<String> x)

x.firstname NOT IN SET $1

IgnoreCase

findByFirstnameIgnoreCase(String firstName)

x.firstname.equalsIgnoreCase($1)

(无关键字)

findByFirstname(String name)

x.firstname = $1

Like

findByFirstnameLike(String name)

x.firstname LIKE $1

Not

findByFirstnameNot(String name)

x.firstname != $1

IsTrue, True

findByActiveIsTrue()

x.active = true

IsFalse, False

findByActiveIsFalse()

x.active = false

10.4. 使用注解的 OQL 查询扩展

许多查询语言,例如 Apache Geode 的 OQL(对象查询语言),都有一些 Spring Data Commons 的 Repository 基础设施不支持的扩展。

Spring Data Commons 的 Repository 基础设施的目标之一是充当最低公分母,以维护对当今应用程序开发中使用最广泛的各种数据存储的支持和可移植性。从技术上讲,这意味着开发人员可以通过重用其现有的特定于应用程序的 Repository 接口来访问其应用程序中 Spring Data Commons 支持的多个不同数据存储,这是一个方便且强大的抽象。

为了支持 Apache Geode 的 OQL 查询语言扩展并保持跨不同数据存储的可移植性,Spring Data for Apache Geode 通过使用 Java 注解添加了对 OQL 查询扩展的支持。这些注解会被其他 Spring Data Repository 实现(例如 Spring Data JPA 或 Spring Data Redis)忽略,这些实现没有类似的查询语言功能。

例如,大多数数据存储可能没有实现 Apache Geode 的 OQL IMPORT 关键字。将 IMPORT 实现为注解(即 @Import)而不是作为查询方法签名的一部分(具体来说,是方法“名称”),不会在评估查询方法名称以构建另一个数据存储语言适当的查询时干扰解析基础设施。

目前,Spring Data for Apache Geode 支持的 Apache Geode OQL 查询语言扩展集包括

表 5. Repository 查询方法支持的 Apache Geode OQL 扩展
关键字 注解 描述 参数

HINT

@Hint

OQL 查询索引提示

String[](例如 @Hint({ "IdIdx", "TxDateIdx" }))

IMPORT

@Import

限定特定于应用程序的类型。

String(例如 @Import("org.example.app.domain.Type"))

LIMIT

@Limit

限制返回的查询结果集。

Integer(例如 @Limit(10); 默认值为 Integer.MAX_VALUE)

TRACE

@Trace

启用 OQL 查询特定的调试。

NA

例如,假设您有一个名为 Customers 的应用程序域类和相应的 Apache Geode 区域,以及一个 CustomerRepository 和一个用于按姓氏查找 Customers 的查询方法,如下所示

示例 10. 示例客户存储库
package ...;

import org.springframework.data.annotation.Id;
import org.springframework.data.gemfire.mapping.annotation.Region;

...

@Region("Customers")
public class Customer ... {

  @Id
  private Long id;

  ...
}
package ...;

import org.springframework.data.gemfire.repository.GemfireRepository;
...

public interface CustomerRepository extends GemfireRepository<Customer, Long> {

  @Trace
  @Limit(10)
  @Hint("LastNameIdx")
  @Import("org.example.app.domain.Customer")
  List<Customer> findByLastName(String lastName);

  ...
}

前面的示例导致以下 OQL 查询

<TRACE> <HINT 'LastNameIdx'> IMPORT org.example.app.domain.Customer; SELECT * FROM /Customers x WHERE x.lastName = $1 LIMIT 10

Spring Data for Apache Geode 的存储库扩展谨慎地避免在使用 OQL 注释扩展与 @Query 注释结合使用时创建冲突的声明。

再举一个例子,假设您在 CustomerRepository 中定义了一个原始的 @Query 注释的查询方法,如下所示

示例 11. CustomerRepository
public interface CustomerRepository extends GemfireRepository<Customer, Long> {

  @Trace
  @Limit(10)
  @Hint("CustomerIdx")
  @Import("org.example.app.domain.Customer")
  @Query("<TRACE> <HINT 'ReputationIdx'> SELECT DISTINCT * FROM /Customers c WHERE c.reputation > $1 ORDER BY c.reputation DESC LIMIT 5")
  List<Customer> findDistinctCustomersByReputationGreaterThanOrderByReputationDesc(Integer reputation);

}

前面的查询方法导致以下 OQL 查询

IMPORT org.example.app.domain.Customer; <TRACE> <HINT 'ReputationIdx'> SELECT DISTINCT * FROM /Customers x WHERE x.reputation > $1 ORDER BY c.reputation DESC LIMIT 5

@Limit(10) 注释不会覆盖原始查询中显式定义的 LIMIT。同样,@Hint("CustomerIdx") 注释不会覆盖原始查询中显式定义的 HINT。最后,@Trace 注释是多余的,不会产生额外的影响。

ReputationIdx 索引可能不是最合理的索引,因为可能有很多客户具有相同的声誉值,这会降低索引的有效性。请明智地选择索引和其他优化,因为不当或选择不当的索引可能会因为维护索引的开销而对您的性能产生相反的影响。ReputationIdx 仅用于示例目的。

10.5. 查询后处理

由于使用了 Spring Data 存储库抽象,定义数据存储特定查询(例如 OQL)的查询方法约定非常简单方便。但是,有时您可能仍然希望检查甚至修改从存储库查询方法生成的查询。

从 2.0.x 版本开始,Spring Data for Apache Geode 包含 o.s.d.gemfire.repository.query.QueryPostProcessor 函数接口。该接口的定义如下

示例 12. QueryPostProcessor
package org.springframework.data.gemfire.repository.query;

import org.springframework.core.Ordered;
import org.springframework.data.repository.Repository;
import org.springframework.data.repository.query.QueryMethod;
import ...;

@FunctionalInterface
interface QueryPostProcessor<T extends Repository, QUERY> extends Ordered {

  QUERY postProcess(QueryMethod queryMethod, QUERY query, Object... arguments);

}

提供了一些额外的默认方法,允许您像使用 java.util.function.Function.andThen(:Function)java.util.function.Function.compose(:Function) 一样来组合 QueryPostProcessor 的实例。

此外,QueryPostProcessor 接口实现了 org.springframework.core.Ordered 接口,这在多个 QueryPostProcessors 在 Spring 容器中声明和注册并用于为一组生成的查询方法查询创建处理管道时很有用。

最后,QueryPostProcessor 接受与类型参数 TQUERY 分别对应的类型参数。类型 T 扩展了 Spring Data Commons 标记接口,org.springframework.data.repository.Repository。我们将在本节后面进一步讨论这一点。Spring Data for Apache Geode 中的所有 QUERY 类型参数都是 java.lang.String 类型。

将查询定义为 QUERY 类型很有用,因为此 QueryPostProcessor 接口可能移植到 Spring Data Commons,因此必须处理不同数据存储(如 JPA、MongoDB 或 Redis)的所有查询形式。

您可以实现此接口以接收一个回调,其中包含从应用程序 Repository 接口方法调用该方法时生成的查询。

例如,您可能希望记录来自所有应用程序 Repository 接口定义的所有查询。您可以通过使用以下 QueryPostProcessor 实现来做到这一点

示例 13. LoggingQueryPostProcessor
package example;

import ...;

class LoggingQueryPostProcessor implements QueryPostProcessor<Repository, String> {

  private Logger logger = Logger.getLogger("someLoggerName");

  @Override
  public String postProcess(QueryMethod queryMethod, String query, Object... arguments) {

      String message = String.format("Executing query [%s] with arguments [%s]", query, Arrays.toString(arguments));

      this.logger.info(message);
  }
}

LoggingQueryPostProcessor 被类型化为 Spring Data org.springframework.data.repository.Repository 标记接口,因此记录所有应用程序 Repository 接口查询方法生成的查询。

您可以将此日志记录的范围限制为仅来自某些类型的应用程序 Repository 接口的查询,例如,CustomerRepository,如下例所示

示例 14. CustomerRepository
interface CustomerRepository extends CrudRepository<Customer, Long> {

  Customer findByAccountNumber(String accountNumber);

  List<Customer> findByLastNameLike(String lastName);

}

然后,您可以将 LoggingQueryPostProcessor 特定类型化为 CustomerRepository,如下所示

示例 15. CustomerLoggingQueryPostProcessor
class LoggingQueryPostProcessor implements QueryPostProcessor<CustomerRepository, String> { .. }

因此,仅记录在 CustomerRepository 接口中定义的查询,例如 findByAccountNumber

您可能希望为 Repository 查询方法定义的特定查询创建一个 QueryPostProcessor。例如,假设您希望将从 CustomerRepository.findByLastNameLike(:String) 查询方法生成的 OQL 查询限制为仅返回五个结果,并按 firstName 升序对 Customers 进行排序。为此,您可以定义一个自定义 QueryPostProcessor,如下例所示

示例 16. OrderedLimitedCustomerByLastNameQueryPostProcessor
class OrderedLimitedCustomerByLastNameQueryPostProcessor implements QueryPostProcessor<CustomerRepository, String> {

  private final int limit;

  public OrderedLimitedCustomerByLastNameQueryPostProcessor(int limit) {
    this.limit = limit;
  }

  @Override
  public String postProcess(QueryMethod queryMethod, String query, Object... arguments) {

    return "findByLastNameLike".equals(queryMethod.getName())
      ? query.trim()
          .replace("SELECT", "SELECT DISTINCT")
          .concat(" ORDER BY firstName ASC")
          .concat(String.format(" LIMIT %d", this.limit))
      : query;
  }
}

虽然前面的示例有效,但您可以通过使用 Spring Data for Apache Geode 提供的 Spring Data 存储库约定来实现相同的效果。例如,可以按如下方式定义相同的查询

示例 17. 使用约定的 CustomerRepository
interface CustomerRepository extends CrudRepository<Customer, Long> {

  @Limit(5)
  List<Customer> findDistinctByLastNameLikeOrderByFirstNameDesc(String lastName);

}

但是,如果您无法控制应用程序 CustomerRepository 接口定义,那么 QueryPostProcessor(即 OrderedLimitedCustomerByLastNameQueryPostProcessor)很方便。

如果您想确保 LoggingQueryPostProcessor 始终在其他可能已在 Spring ApplicationContext 中声明和注册的应用程序定义的 QueryPostProcessors 之后出现,您可以通过覆盖 o.s.core.Ordered.getOrder() 方法来设置 order 属性,如下例所示

示例 18. 定义 order 属性
class LoggingQueryPostProcessor implements QueryPostProcessor<Repository, String> {

  @Override
  int getOrder() {
    return 1;
  }
}

class CustomerQueryPostProcessor implements QueryPostProcessor<CustomerRepository, String> {

  @Override
  int getOrder() {
    return 0;
  }
}

这确保您始终在 LoggingQueryPostProcessor 记录查询之前看到其他 QueryPostProcessors 应用的后处理效果。

您可以在 Spring ApplicationContext 中定义任意数量的 QueryPostProcessors,并按任何顺序将它们应用于所有或特定应用程序存储库接口,并通过使用提供给 postProcess(..) 方法回调的参数来实现尽可能细粒度的控制。

11. 函数执行的注解支持

Spring Data for Apache Geode 包含注解支持,以简化使用 Apache Geode 函数执行 的工作。

在幕后,Apache Geode API 提供了类来实现和注册 Apache Geode 函数,这些函数部署在 Apache Geode 服务器上,然后可以由其他对等成员应用程序或从缓存客户端远程调用。

函数可以在并行执行,分布在集群中的多个 Apache Geode 服务器上,使用 map-reduce 模式聚合结果并发送回调用方。函数也可以被定位到单个服务器或区域上。Apache Geode API 支持使用各种预定义范围定位的函数的远程执行:在区域上、在成员(在组中)上、在服务器上以及其他范围。与任何 RPC 协议一样,远程函数的实现和执行需要一些样板代码。

Spring Data for Apache Geode 忠实于 Spring 的核心价值主张,旨在隐藏远程函数执行的机制,让您专注于核心 POJO 编程和业务逻辑。为此,Spring Data for Apache Geode 引入了注解,以声明性地将 POJO 类的公共方法注册为 Apache Geode 函数,以及通过使用带注解的接口来调用注册的函数(包括远程调用)的能力。

11.1. 实现与执行

需要解决两个独立的问题:实现和执行。

首先是函数实现(服务器端),它必须与 FunctionContext 交互以访问调用参数,与 ResultsSender 交互以发送结果,以及其他执行上下文信息。函数实现通常访问缓存和区域,并在 FunctionService 中使用唯一 ID 注册。

调用函数的缓存客户端应用程序不依赖于实现。为了调用函数,应用程序实例化一个 Execution,提供函数 ID、调用参数和函数目标,该目标定义了其范围:区域、服务器、服务器组、成员或成员组。如果函数产生结果,调用者使用 ResultCollector 来聚合和获取执行结果。在某些情况下,需要自定义的 ResultCollector 实现,并可能在 Execution 中注册。

“客户端”和“服务器”在此处用于函数执行的上下文中,可能与 Apache Geode 的客户端-服务器拓扑中的客户端和服务器具有不同的含义。虽然使用 ClientCache 实例的应用程序通常会在集群中的一个或多个 Apache Geode 服务器上调用函数,但也可以在对等(P2P)配置中执行函数,其中应用程序是托管对等 Cache 实例的集群的成员。请记住,对等成员缓存应用程序受作为集群对等成员的所有约束。

11.2. 实现函数

使用 Apache Geode API,FunctionContext 提供了一个运行时调用上下文,其中包括客户端的调用参数和一个 ResultSender 实现,用于将结果发送回客户端。此外,如果函数在区域上执行,FunctionContext 实际上是 RegionFunctionContext 的实例,它提供了更多信息,例如调用函数的目标区域、与 Execution 关联的任何过滤器(一组特定键)等等。如果区域是 PARTITION 区域,函数应使用 PartitionRegionHelper 来提取本地数据集。

通过使用 Spring,您可以编写一个简单的 POJO,并使用 Spring 容器将一个或多个 POJO 的公共方法绑定到一个 Function。用于作为 Function 的 POJO 方法的签名通常必须符合客户端的执行参数。但是,在 Region 执行的情况下,Region 数据也可能被提供(假设数据保存在本地分区中,如果 Region 是一个 PARTITION Region)。

此外,Function 可能需要应用的过滤器(如果有)。这表明客户端和服务器共享调用参数的契约,但方法签名可能包含额外的参数来传递由 FunctionContext 提供的值。一种可能性是客户端和服务器共享一个公共接口,但这并不是严格要求的。唯一的约束是方法签名包含与调用 Function 时使用的相同顺序的调用参数,在解析额外的参数后。

例如,假设客户端提供一个 String 和一个 int 作为调用参数。这些参数在 FunctionContext 中以数组的形式提供,如下例所示

Object[] args = new Object[] { "test", 123 };

Spring 容器应该能够绑定到任何类似于以下方法签名(暂时忽略返回值类型)

public Object method1(String s1, int i2) { ... }
public Object method2(Map<?, ?> data, String s1, int i2) { ... }
public Object method3(String s1, Map<?, ?> data, int i2) { ... }
public Object method4(String s1, Map<?, ?> data, Set<?> filter, int i2) { ... }
public void method4(String s1, Set<?> filter, int i2, Region<?,?> data) { ... }
public void method5(String s1, ResultSender rs, int i2) { ... }
public void method6(FunctionContest context) { ... }

一般规则是,一旦解析了任何额外的参数(即 Region 数据和过滤器),剩余的参数必须在顺序和类型上完全对应于预期的 Function 方法参数。方法的返回值类型必须是 void 或可以序列化的类型(作为 java.io.SerializableDataSerializablePdxSerializable)。后者也是调用参数的要求。

Region 数据通常应该定义为一个 Map,以方便单元测试,但如果需要,也可以是 Region 类型。如前面的示例所示,传递 FunctionContext 本身或 ResultSender 也是有效的,如果您需要控制结果如何返回给客户端。

11.2.1. Function 实现的注解

以下示例展示了如何使用 SDG 的函数注解将 POJO 方法公开为 Apache Geode 函数。

@Component
public class ApplicationFunctions {

   @GemfireFunction
   public String function1(String value, @RegionData Map<?, ?> data, int i2) { ... }

   @GemfireFunction(id = "myFunction", batchSize=100, HA=true, optimizedForWrite=true)
   public List<String> function2(String value, @RegionData Map<?, ?> data, int i2, @Filter Set<?> keys) { ... }

   @GemfireFunction(hasResult=true)
   public void functionWithContext(FunctionContext functionContext) { ... }

}

请注意,该类本身必须注册为 Spring bean,并且每个 Apache Geode 函数都用 @GemfireFunction 注解。在前面的示例中,使用了 Spring 的 @Component 注解,但您可以使用 Spring 支持的任何方法(例如 XML 配置或在使用 Spring Boot 时使用 Java 配置类)来注册 bean。这使 Spring 容器能够创建此类的实例并将其包装在 PojoFunctionWrapper 中。Spring 为每个用 @GemfireFunction 注解的方法创建了一个包装器实例。每个包装器实例共享相同的目标对象实例来调用相应的方法。

POJO 函数类是 Spring bean 的事实可能会带来其他好处。由于它与 Apache Geode 组件(例如缓存和区域)共享 ApplicationContext,因此如果需要,可以将这些组件注入到该类中。

Spring 创建包装器类并将函数注册到 Apache Geode 的 FunctionService 中。用于注册每个函数的函数 ID 必须是唯一的。按照惯例,它默认为简单(未限定)方法名称。可以使用 @GemfireFunction 注解的 id 属性显式定义名称。

@GemfireFunction 注解还提供其他配置属性:HAoptimizedForWrite,它们对应于 Apache Geode 的 Function 接口定义的属性。

如果 POJO 函数方法的返回类型为 void,则 hasResult 属性将自动设置为 false。否则,如果方法返回一个值,则 hasResult 属性将设置为 true。即使对于 void 方法返回类型,也可以将 GemfireFunction 注释的 hasResult 属性设置为 true 来覆盖此约定,如前面显示的 functionWithContext 方法所示。据推测,您的意图是直接使用 ResultSender 将结果发送给调用者。

最后,GemfireFunction 注释支持 requiredPermissions 属性,该属性指定执行函数所需的权限。默认情况下,所有函数都需要 DATA:WRITE 权限。该属性接受一个字符串数组,允许您根据应用程序和/或函数 UC 的需要修改权限。每个资源权限都应采用以下格式:<RESOURCE>:<OPERATION>:[Target]:[Key]

RESOURCE 可以是 {data-store-javadoc]/org/apache/geode/security/ResourcePermission.Resource.html[ResourcePermission.Resource] 枚举值之一。OPERATION 可以是 {data-store-javadoc]/org/apache/geode/security/ResourcePermission.Operation.html[ResourcePermission.Operation] 枚举值之一。可选地,Target 可以是区域的名称或 {data-store-javadoc]/org/apache/geode/security/ResourcePermission.Target.html[ResourcePermission.Target] 枚举值之一。最后,可选地,Key 是指定的目标区域中的有效键。

PojoFunctionWrapper 实现 Apache Geode 的 Function 接口,绑定方法参数,并在其 execute() 方法中调用目标方法。它还使用 ResultSender 将方法的返回值发送回调用者。

11.2.2. 批量结果

如果返回类型是数组或 Collection,则必须考虑如何返回结果。默认情况下,PojoFunctionWrapper 会一次性返回整个数组或 Collection。如果数组或 Collection 中的元素数量很大,则可能会导致性能下降。为了将有效负载划分为更小、更易于管理的块,您可以设置 batchSize 属性,如前面显示的 function2 中所示。

如果您需要更多地控制 ResultSender,特别是如果方法本身会使用太多内存来创建 Collection,则可以传入 ResultSender 或通过 FunctionContext 访问它,并直接在方法中使用它将结果发送回调用者。

11.2.3. 启用注释处理

根据 Spring 标准,您必须显式激活 @GemfireFunction 注释的注释处理。以下示例使用 XML 激活注释处理

<gfe:annotation-driven/>

以下示例通过注释 Java 配置类来激活注释处理

@Configuration
@EnableGemfireFunctions
class ApplicationConfiguration { ... }

11.3. 执行函数

调用远程函数的进程需要提供函数的 ID、调用参数、执行目标(onRegiononServersonServeronMemberonMembers)以及(可选)过滤器集。通过使用 Spring Data for Apache Geode,您只需定义一个由注释支持的接口。Spring 为该接口创建一个动态代理,该代理使用 FunctionService 创建一个 Execution,调用 Execution,并在必要时将结果强制转换为定义的返回类型。此技术类似于 Spring Data for Apache Geode 的 Repository 扩展的工作方式。因此,某些配置和概念应该很熟悉。

通常,单个接口定义映射到多个函数执行,每个函数执行对应于接口中定义的每个方法。

11.3.1. 函数执行的注释

为了支持客户端函数执行,提供了以下 SDG 函数注释:@OnRegion@OnServer@OnServers@OnMember@OnMembers。这些注释对应于 Apache Geode 的 FunctionService 类提供的 Execution 实现。

每个注释都公开相应的属性。这些注释还提供了一个可选的 resultCollector 属性,其值为实现 ResultCollector 接口的 Spring bean 的名称,用于执行。

代理接口将所有声明的方法绑定到相同的执行配置。尽管预期单方法接口很常见,但接口中的所有方法都由同一个代理实例支持,因此它们共享相同的配置。

以下列表显示了一些示例

@OnRegion(region="SomeRegion", resultCollector="myCollector")
public interface FunctionExecution {

    @FunctionId("function1")
    String doIt(String s1, int i2);

    String getString(Object arg1, @Filter Set<Object> keys);

}

默认情况下,函数 ID 是简单(非限定)方法名称。@FunctionId 注释可用于将此调用绑定到不同的函数 ID。

11.3.2. 启用注解处理

客户端使用 Spring 的类路径组件扫描功能来发现带注解的接口。要在 XML 中启用 Function 执行注解处理,请在您的 XML 配置中插入以下元素

<gfe-data:function-executions base-package="org.example.myapp.gemfire.functions"/>

function-executions 元素在 gfe-data XML 命名空间中提供。base-package 属性是必需的,以避免扫描整个类路径。可以根据 Spring 参考文档 中的描述提供其他过滤器。

或者,您可以按如下方式注释您的 Java 配置类

@EnableGemfireFunctionExecutions(basePackages = "org.example.myapp.gemfire.functions")

11.4. 编程方式的 Function 执行

使用上一节中定义的 Function 执行带注解的接口,只需将您的接口自动装配到将调用 Function 的应用程序 bean 中即可

@Component
public class MyApplication {

    @Autowired
    FunctionExecution functionExecution;

    public void doSomething() {
         functionExecution.doIt("hello", 123);
    }
}

或者,您可以直接使用 Function 执行模板。在以下示例中,GemfireOnRegionFunctionTemplate 创建了一个 onRegion Function Execution

示例 19. 使用 GemfireOnRegionFunctionTemplate
Set<?, ?> myFilter = getFilter();
Region<?, ?> myRegion = getRegion();
GemfireOnRegionOperations template = new GemfireOnRegionFunctionTemplate(myRegion);
String result = template.executeAndExtract("someFunction", myFilter, "hello", "world", 1234);

在内部,Function Executions 始终返回一个 ListexecuteAndExtract 假设一个包含结果的单例 List,并尝试将该值强制转换为请求的类型。还有一个 execute 方法按原样返回 List。第一个参数是 Function ID。过滤器参数是可选的。其余参数是可变参数 List

11.5. 使用 PDX 的 Function 执行

在使用 Spring Data for Apache Geode 的 Function 注解支持与 Apache Geode 的 PDX 序列化 相结合时,需要牢记一些逻辑上的事项。

如本节前面所述,并以示例说明,您通常应该使用带 Spring Data for Apache Geode Function 注解 的 POJO 类来定义 Apache Geode Function,如下所示

public class OrderFunctions {

  @GemfireFunction(...)
  Order process(@RegionData data, Order order, OrderSource orderSourceEnum, Integer count) { ... }

}
Integer 类型的 count 参数是任意的,Order 类和 OrderSource 枚举的划分也是任意的,它们在逻辑上可以合并。但是,参数的设置方式是为了演示在 PDX 上下文中 Function 执行的问题。

您的 Order 类和 OrderSource 枚举可能定义如下

public class Order ... {

  private Long orderNumber;
  private LocalDateTime orderDateTime;
  private Customer customer;
  private List<Item> items

  ...
}


public enum OrderSource {
  ONLINE,
  PHONE,
  POINT_OF_SALE
  ...
}

当然,您可以定义一个 Function `Execution` 接口来调用 'process' Apache Geode 服务器 Function,如下所示

@OnServer
public interface OrderProcessingFunctions {
  Order process(Order order, OrderSource orderSourceEnum, Integer count);
}

显然,这个 `process(..)` `Order` Function 是从客户端使用 `ClientCache` 实例(即 ``)调用的。这意味着 Function 参数也必须是可序列化的。当在集群中的对等节点之间调用对等节点到对等节点成员 Function(例如 `@OnMember(s)`)时,情况也是如此。任何形式的 `distribution` 都需要在客户端和服务器(或对等节点)之间传输的数据进行序列化。

现在,如果您已将 Apache Geode 配置为使用 PDX 进行序列化(例如,而不是使用 Java 序列化),您也可以在 Apache Geode 服务器的配置中将 `pdx-read-serialized` 属性设置为 `true`,如下所示

<gfe:cache pdx-read-serialized="true"/>

或者,您可以将 `pdx-read-serialized` 属性设置为 `true`,用于 Apache Geode 缓存客户端应用程序,如下所示

<gfe:client-cache pdx-read-serialized="true"/>

这样做会导致从缓存(即 Regions)读取的所有值以及在客户端和服务器(或对等节点)之间传递的信息保持序列化形式,包括但不限于 Function 参数。

Apache Geode 仅序列化您已明确配置(注册)的应用程序域对象类型,方法是使用 Apache Geode 的 `ReflectionBasedAutoSerializer`,或专门(建议)使用“自定义”Apache Geode `PdxSerializer`。如果您使用 Spring Data for Apache Geode 的 Repository 扩展,您甚至可能想要考虑使用 Spring Data for Apache Geode 的 `MappingPdxSerializer`,它使用实体的映射元数据来确定从应用程序域对象中序列化到 PDX 实例的数据。

然而,不那么明显的是,Apache Geode 会自动处理 Java `Enum` 类型,无论它们是否被明确配置(即,使用 `ReflectionBasedAutoSerializer` 注册,使用正则表达式模式和 `classes` 参数,或由“自定义”Apache Geode `PdxSerializer` 处理),尽管 Java 枚举实现了 `java.io.Serializable`。

因此,当您在注册了 Apache Geode Function(包括 Spring Data for Apache Geode Function 注释的 POJO 类)的 Apache Geode 服务器上将 `pdx-read-serialized` 设置为 `true` 时,您可能会在调用 Function `Execution` 时遇到意外的行为。

在调用函数时,您可能会传递以下参数

orderProcessingFunctions.process(new Order(123, customer, LocalDateTime.now(), items), OrderSource.ONLINE, 400);

但是,服务器上的 Apache Geode 函数会收到以下内容

process(regionData, order:PdxInstance, :PdxInstanceEnum, 400);

OrderOrderSource 已作为 PDX 实例 传递给函数。同样,这一切都是因为 pdx-read-serialized 设置为 true,这在 Apache Geode 服务器与多个不同客户端交互(例如,Java 客户端和本机客户端,如 C/C++、C# 等)的情况下可能是必要的。

这与 Spring Data for Apache Geode 的强类型函数注释 POJO 类方法签名相冲突,在这些签名中,您会合理地期望应用程序域对象类型而不是 PDX 序列化实例。

因此,Spring Data for Apache Geode 包含增强的函数支持,以自动将 PDX 类型的方法参数转换为函数方法签名(参数类型)定义的所需应用程序域对象类型。

但是,这也要求您在注册和使用 Spring Data for Apache Geode 函数注释 POJO 的 Apache Geode 服务器上显式注册 Apache Geode PdxSerializer,如下例所示

<bean id="customPdxSerializer" class="x.y.z.gemfire.serialization.pdx.MyCustomPdxSerializer"/>

<gfe:cache pdx-serializer-ref="customPdxSerializeer" pdx-read-serialized="true"/>

或者,您可以使用 Apache Geode 的 ReflectionBasedAutoSerializer 以方便起见。当然,我们建议您尽可能使用自定义 PdxSerializer 来维护对序列化策略的更细粒度控制。

最后,Spring Data for Apache Geode 谨慎地不会转换您的函数参数,如果您以通用方式或作为 Apache Geode 的 PDX 类型之一来处理您的函数参数,如下所示

@GemfireFunction
public Object genericFunction(String value, Object domainObject, PdxInstanceEnum pdxEnum) {
  // ...
}

Spring Data for Apache Geode 仅当相应的应用程序域类型在类路径上且函数注释 POJO 方法期望它时,才会将 PDX 类型的数据转换为相应的应用程序域类型。

有关自定义、组合的应用程序特定 Apache Geode PdxSerializers 以及基于方法签名的适当 POJO 函数参数类型处理的良好示例,请参阅 Spring Data for Apache Geode 的 ClientCacheFunctionExecutionWithPdxIntegrationTest 类。

12. Apache Lucene 集成

Apache Geode 集成 Apache Lucene,允许您使用 Lucene 查询对存储在 Apache Geode 中的数据进行索引和搜索。基于搜索的查询还包括分页查询结果的功能。

此外,Spring Data for Apache Geode 添加了对基于 Spring Data Commons 投影基础设施的查询投影的支持。此功能允许根据应用程序的需要将查询结果投影到一流的应用程序域类型中。

在运行任何基于 Lucene 搜索的查询之前,必须创建 Lucene Index。可以在 Spring(Data for Apache Geode)XML 配置中创建 LuceneIndex,如下所示

<gfe:lucene-index id="IndexOne" fields="fieldOne, fieldTwo" region-path="/Example"/>

此外,Apache Lucene 允许为每个字段指定 分析器,并且可以按照以下示例进行配置

<gfe:lucene-index id="IndexTwo" lucene-service-ref="luceneService" region-path="/AnotherExample">
    <gfe:field-analyzers>
        <map>
            <entry key="fieldOne">
                <bean class="example.AnalyzerOne"/>
             </entry>
            <entry key="fieldTwo">
                <bean class="example.AnalyzerTwo"/>
             </entry>
        </map>
    </gfe:field-analyzers>
</gfe:lucene-index>

Map 可以指定为顶级 bean 定义,并使用嵌套的 <gfe:field-analyzers> 元素中的 ref 属性进行引用,如下所示:<gfe-field-analyzers ref="refToTopLevelMapBeanDefinition"/>

Spring Data for Apache Geode 的 LuceneIndexFactoryBean API 和 SDG 的 XML 命名空间还允许在创建 LuceneIndex 时指定 org.apache.geode.cache.lucene.LuceneSerializerLuceneSerializer 允许您配置在对对象进行索引时将对象转换为 Lucene 文档的方式。

以下示例显示了如何将 LuceneSerializer 添加到 LuceneIndex

<bean id="MyLuceneSerializer" class="example.CustomLuceneSerializer"/>

<gfe:lucene-index id="IndexThree" lucene-service-ref="luceneService" region-path="/YetAnotherExample">
    <gfe:lucene-serializer ref="MyLuceneSerializer">
</gfe:lucene-index>

您也可以将 LuceneSerializer 指定为匿名嵌套 bean 定义,如下所示

<gfe:lucene-index id="IndexThree" lucene-service-ref="luceneService" region-path="/YetAnotherExample">
    <gfe:lucene-serializer>
        <bean class="example.CustomLuceneSerializer"/>
    </gfe:lucene-serializer>
</gfe:lucene-index>

或者,您可以在 Spring Java 配置中声明或定义 LuceneIndex,在 @Configuration 类中,如下例所示

@Bean(name = "Books")
@DependsOn("bookTitleIndex")
PartitionedRegionFactoryBean<Long, Book> booksRegion(GemFireCache gemfireCache) {

    PartitionedRegionFactoryBean<Long, Book> peopleRegion =
        new PartitionedRegionFactoryBean<>();

    peopleRegion.setCache(gemfireCache);
    peopleRegion.setClose(false);
    peopleRegion.setPersistent(false);

    return peopleRegion;
}

@Bean
LuceneIndexFactoryBean bookTitleIndex(GemFireCache gemFireCache,
        LuceneSerializer luceneSerializer) {

    LuceneIndexFactoryBean luceneIndex = new LuceneIndexFactoryBean();

    luceneIndex.setCache(gemFireCache);
    luceneIndex.setFields("title");
    luceneIndex.setLuceneSerializer(luceneSerializer);
    luceneIndex.setRegionPath("/Books");

    return luceneIndex;
}

@Bean
CustomLuceneSerializer myLuceneSerialier() {
    return new CustomeLuceneSerializer();
}

Apache Geode 的 Apache Lucene 集成和支持存在一些限制。

首先,只能在 Apache Geode PARTITION 区域上创建 LuceneIndex

其次,所有 LuceneIndexes 必须在应用 LuceneIndex 的区域之前创建。

为了帮助确保在 Spring 容器中定义的所有声明的 LuceneIndexes 都在它们所应用的区域之前创建,SDG 包含 org.springframework.data.gemfire.config.support.LuceneIndexRegionBeanFactoryPostProcessor。您可以使用 <bean class="org.springframework.data.gemfire.config.support.LuceneIndexRegionBeanFactoryPostProcessor"/> 在 XML 配置中注册此 Spring BeanFactoryPostProcessoro.s.d.g.config.support.LuceneIndexRegionBeanFactoryPostProcessor 只能在使用 SDG XML 配置时使用。有关 Spring 的 BeanFactoryPostProcessors 的更多详细信息,请参阅 此处

这些 Apache Geode 限制可能不会在将来的版本中适用,这就是为什么 SDG LuceneIndexFactoryBean API 直接引用区域,而不仅仅是区域路径的原因。

当您希望在应用程序生命周期的后期阶段,根据需求在现有包含数据的 Region 上定义 LuceneIndex 时,这种方法更理想。在可能的情况下,SDG 努力坚持使用强类型对象。但是,目前,您必须使用 regionPath 属性来指定应用 LuceneIndex 的 Region。

此外,在前面的示例中,请注意 Books Region bean 定义上存在 Spring 的 @DependsOn 注解。这在 Books Region bean 和 bookTitleIndex LuceneIndex bean 定义之间创建了一个依赖关系,确保在应用 LuceneIndex 的 Region 之前创建 LuceneIndex

现在,一旦我们有了 LuceneIndex,就可以执行基于 Lucene 的数据访问操作,例如查询。

12.1. Lucene 模板数据访问器

Spring Data for Apache Geode 提供了两种主要模板用于 Lucene 数据访问操作,具体取决于您的应用程序准备处理的级别。

LuceneOperations 接口使用 Apache Geode Lucene 类型 定义查询操作,这些类型在以下接口定义中定义

public interface LuceneOperations {

    <K, V> List<LuceneResultStruct<K, V>> query(String query, String defaultField [, int resultLimit]
        , String... projectionFields);

    <K, V> PageableLuceneQueryResults<K, V> query(String query, String defaultField,
        int resultLimit, int pageSize, String... projectionFields);

    <K, V> List<LuceneResultStruct<K, V>> query(LuceneQueryProvider queryProvider [, int resultLimit]
        , String... projectionFields);

    <K, V> PageableLuceneQueryResults<K, V> query(LuceneQueryProvider queryProvider,
        int resultLimit, int pageSize, String... projectionFields);

    <K> Collection<K> queryForKeys(String query, String defaultField [, int resultLimit]);

    <K> Collection<K> queryForKeys(LuceneQueryProvider queryProvider [, int resultLimit]);

    <V> Collection<V> queryForValues(String query, String defaultField [, int resultLimit]);

    <V> Collection<V> queryForValues(LuceneQueryProvider queryProvider [, int resultLimit]);
}
[, int resultLimit] 表示 resultLimit 参数是可选的。

LuceneOperations 接口中的操作与 Apache Geode 的 LuceneQuery 接口提供的操作相匹配。但是,SDG 具有将专有的 Apache Geode 或 Apache Lucene Exceptions 转换为 Spring 高度一致且表达力强的 DAO 异常层次结构 的附加值,特别是因为许多现代数据访问操作涉及多个存储或存储库。

此外,SDG 的 LuceneOperations 接口可以保护您的应用程序免受底层 Apache Geode 或 Apache Lucene API 在发生时引入的接口破坏性更改。

但是,提供一个仅使用 Apache Geode 和 Apache Lucene 数据类型(例如 Apache Geode 的 LuceneResultStruct)的 Lucene 数据访问对象 (DAO) 会很遗憾。因此,SDG 为您提供了 ProjectingLuceneOperations 接口来解决这些重要的应用程序问题。以下清单显示了 ProjectingLuceneOperations 接口定义

public interface ProjectingLuceneOperations {

    <T> List<T> query(String query, String defaultField [, int resultLimit], Class<T> projectionType);

    <T> Page<T> query(String query, String defaultField, int resultLimit, int pageSize, Class<T> projectionType);

    <T> List<T> query(LuceneQueryProvider queryProvider [, int resultLimit], Class<T> projectionType);

    <T> Page<T> query(LuceneQueryProvider queryProvider, int resultLimit, int pageSize, Class<T> projectionType);
}

ProjectingLuceneOperations 接口主要使用应用程序域对象类型,使您可以使用应用程序数据。query 方法变体接受投影类型,模板使用 Spring Data Commons Projection 基础设施将查询结果应用于给定投影类型的实例。

此外,模板将分页的 Lucene 查询结果包装在 Spring Data Commons Page 抽象的实例中。相同的投影逻辑仍然可以应用于页面中的结果,并且在访问集合中的每个页面时会延迟投影。

例如,假设您有一个表示 Person 的类,如下所示

class Person {

    Gender gender;

    LocalDate birthDate;

    String firstName;
    String lastName;

    ...

    String getName() {
        return String.format("%1$s %2$s", getFirstName(), getLastName());
    }
}

此外,您可能有一个单独的接口来表示人员为 Customers,具体取决于您的应用程序视图,如下所示

interface Customer {

    String getName()

}

如果我定义以下 LuceneIndex…​

@Bean
LuceneIndexFactoryBean personLastNameIndex(GemFireCache gemfireCache) {

    LuceneIndexFactoryBean personLastNameIndex =
        new LuceneIndexFactoryBean();

    personLastNameIndex.setCache(gemfireCache);
    personLastNameIndex.setFields("lastName");
    personLastNameIndex.setRegionPath("/People");

    return personLastNameIndex;
}

那么您可以查询人员作为 Person 对象,如下所示

List<Person> people = luceneTemplate.query("lastName: D*", "lastName", Person.class);

或者,您可以查询类型为 CustomerPage,如下所示

Page<Customer> customers = luceneTemplate.query("lastName: D*", "lastName", 100, 20, Customer.class);

然后可以使用 Page 获取结果的各个页面,如下所示

List<Customer> firstPage = customers.getContent();

方便的是,Spring Data Commons Page 接口还实现了 java.lang.Iterable<T>,使其易于遍历内容。

Spring Data Commons Projection 基础设施的唯一限制是投影类型必须是接口。但是,可以扩展提供的 SDC Projection 基础设施并提供自定义的 ProjectionFactory,该工厂使用 CGLIB 生成代理类作为投影实体。

您可以使用 setProjectionFactory(:ProjectionFactory) 在 Lucene 模板上设置自定义 ProjectionFactory

12.2. 注解配置支持

最后,Spring Data for Apache Geode 为 LuceneIndexes 提供了注释配置支持。

最终,SDG Lucene 支持将进入 Apache Geode 的 Repository 基础设施扩展,以便 Lucene 查询可以像 OQL 支持 今天的工作方式一样,在应用程序 Repository 接口上的方法中表达。

但是,在此期间,如果您想方便地表达 LuceneIndexes,您可以直接在应用程序域对象上执行此操作,如下面的示例所示

@PartitionRegion("People")
class Person {

    Gender gender;

    @Index
    LocalDate birthDate;

    String firstName;

    @LuceneIndex;
    String lastName;

    ...
}

要启用此功能,您必须专门使用 SDG 的注释配置支持,使用 @EnableEntityDefineRegions@EnableIndexing 注释,如下所示

@PeerCacheApplication
@EnableEntityDefinedRegions
@EnableIndexing
class ApplicationConfiguration {

  ...
}
LuceneIndexes 只能在 Apache Geode 服务器上创建,因为 LuceneIndexes 仅适用于 PARTITION 区域。

根据我们之前对Person类的定义,SDG 注解配置支持会找到Person实体类定义,并确定人员存储在名为“People”的PARTITION区域中,并且PersonbirthDate上有一个 OQL Index,在lastName上有一个LuceneIndex

13. 在 Apache Geode 中引导 Spring ApplicationContext

通常,基于 Spring 的应用程序通过使用 Spring Data for Apache Geode 的功能来引导 Apache Geode。通过指定使用 Spring Data for Apache Geode XML 命名空间的<gfe:cache/>元素,会在与您的应用程序相同的 JVM 进程中创建并初始化一个单一的嵌入式 Apache Geode 对等Cache实例,并使用默认设置。

但是,有时可能需要(也许是您的 IT 组织的要求)由提供的 Apache Geode 工具套件完全管理和操作 Apache Geode,也许可以使用Gfsh。通过使用Gfsh,Apache Geode 会引导您的 Spring ApplicationContext,而不是相反。Apache Geode 会代替应用程序服务器或使用 Spring Boot 的 Java 主类来进行引导,并托管您的应用程序。

Apache Geode 不是应用程序服务器。此外,在使用 Apache Geode 缓存配置时,使用这种方法存在一些限制。

13.1. 使用 Apache Geode 引导使用 Gfsh 启动的 Spring 上下文

为了在使用Gfsh启动 Apache Geode 服务器时在 Apache Geode 中引导 Spring ApplicationContext,您必须使用 Apache Geode 的初始化器功能。初始化器块可以声明一个应用程序回调,该回调在 Apache Geode 初始化缓存后启动。

初始化器是在initializer元素中使用 Apache Geode 的本机cache.xml的最小代码片段来声明的。为了引导 Spring ApplicationContext,需要一个cache.xml文件,这与引导使用组件扫描配置的 Spring ApplicationContext所需的 Spring XML 配置的最小代码片段(例如<context:component-scan base-packages="…​"/>)非常相似。

幸运的是,框架已经方便地提供了这样的初始化器:SpringContextBootstrappingInitializer.

以下示例显示了 Apache Geode 的cache.xml文件中此类的典型但最小的配置

<?xml version="1.0" encoding="UTF-8"?>
<cache xmlns="http://geode.apache.org/schema/cache"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://geode.apache.org/schema/cache https://geode.apache.org/schema/cache/cache-1.0.xsd"
       version="1.0">

  <initializer>
    <class-name>org.springframework.data.gemfire.support.SpringContextBootstrappingInitializer</class-name>
    <parameter name="contextConfigLocations">
      <string>classpath:application-context.xml</string>
    </parameter>
  </initializer>

</cache>

SpringContextBootstrappingInitializer类遵循与 Spring 的ContextLoaderListener类类似的约定,该类用于在 Web 应用程序中引导 Spring ApplicationContext,其中ApplicationContext配置文件使用contextConfigLocations Servlet 上下文参数指定。

此外,SpringContextBootstrappingInitializer类也可以与basePackages参数一起使用,以指定包含适当注释的应用程序组件的逗号分隔列表的基包。Spring 容器会搜索这些组件以查找并创建类路径中的 Spring bean 和其他应用程序组件,如下面的示例所示

<?xml version="1.0" encoding="UTF-8"?>
<cache xmlns="http://geode.apache.org/schema/cache"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://geode.apache.org/schema/cache https://geode.apache.org/schema/cache/cache-1.0.xsd"
       version="1.0">

  <initializer>
    <class-name>org.springframework.data.gemfire.support.SpringContextBootstrappingInitializer</class-name>
    <parameter name="basePackages">
      <string>org.mycompany.myapp.services,org.mycompany.myapp.dao,...</string>
    </parameter>
  </initializer>

</cache>

然后,使用正确配置和构建的CLASSPATHcache.xml文件(如前所示)作为启动 Apache Geode 服务器时在 Gfsh 中指定的命令行选项,命令行将如下所示

gfsh>start server --name=ExampleServer --log-level=config ...
    --classpath="/path/to/application/classes.jar:/path/to/spring-data-geode-<major>.<minor>.<maint>.RELEASE.jar"
    --cache-xml-file="/path/to/geode/cache.xml"

application-context.xml 可以是任何有效的 Spring 配置元数据,包括所有 SDG XML 命名空间元素。这种方法的唯一限制是 Apache Geode 缓存不能使用 SDG XML 命名空间进行配置。换句话说,不能指定任何<gfe:cache/> 元素属性(例如cache-xml-locationproperties-refcritical-heap-percentagepdx-serializer-reflock-lease 等)。如果使用,这些属性将被忽略。

这样做的原因是 Apache Geode 本身已经在初始化程序被调用之前创建并初始化了缓存。因此,缓存已经存在,并且由于它是一个“单例”,因此无法重新初始化或增强其任何配置。

13.2. 延迟连接 Apache Geode 组件

Spring Data for Apache Geode 已经提供了对自动连接 Apache Geode 组件(例如CacheListenersCacheLoadersCacheWriters 等)的支持,这些组件由 Apache Geode 在cache.xml 中声明和创建,使用 SDG 的WiringDeclarableSupport 类,如使用自动连接和注释进行配置中所述。但是,这仅在 Spring 进行引导时有效(即,当 Spring 引导 Apache Geode 时)。

当您的 Spring ApplicationContext 由 Apache Geode 引导时,这些 Apache Geode 应用程序组件会被忽略,因为 Spring ApplicationContext 尚未存在。Spring ApplicationContext 直到 Apache Geode 调用初始化程序块才会创建,而初始化程序块仅在所有其他 Apache Geode 组件(缓存、区域等)已经创建和初始化之后才会发生。

为了解决这个问题,引入了一个新的LazyWiringDeclarableSupport 类。这个新类知道 Spring ApplicationContext。这个抽象基类的目的是,任何实现类都注册自己,以便由 Spring 容器配置,该容器最终由 Apache Geode 在调用初始化程序后创建。从本质上讲,这使您的 Apache Geode 应用程序组件有机会使用 Spring 容器中定义的 Spring bean 进行配置和自动连接。

为了使您的 Apache Geode 应用程序组件能够由 Spring 容器自动连接,您应该创建一个扩展LazyWiringDeclarableSupport 的应用程序类,并注释任何需要作为 Spring bean 依赖项提供的类成员,类似于以下示例

public class UserDataSourceCacheLoader extends LazyWiringDeclarableSupport
    implements CacheLoader<String, User> {

  @Autowired
  private DataSource userDataSource;

  ...
}

如上面的CacheLoader 示例所示,您可能需要(尽管很少)在 Apache Geode cache.xml 中定义一个区域和一个CacheListener 组件。CacheLoader 可能需要访问应用程序存储库(或者可能是 Spring ApplicationContext 中定义的 JDBC DataSource)以在启动时将Users 加载到 Apache Geode REPLICATE 区域中。

注意

以这种方式混合 Apache Geode 和 Spring 容器的不同生命周期时,请小心。并非所有用例和场景都受支持。Apache Geode 的 cache.xml 配置将类似于以下内容(来自 SDG 的测试套件)

<?xml version="1.0" encoding="UTF-8"?>
<cache xmlns="http://geode.apache.org/schema/cache"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://geode.apache.org/schema/cache https://geode.apache.org/schema/cache/cache-1.0.xsd"
       version="1.0">

  <region name="Users" refid="REPLICATE">
    <region-attributes initial-capacity="101" load-factor="0.85">
      <key-constraint>java.lang.String</key-constraint>
      <value-constraint>org.springframework.data.gemfire.repository.sample.User</value-constraint>
      <cache-loader>
        <class-name>
          org.springframework.data.gemfire.support.SpringContextBootstrappingInitializerIntegrationTests$UserDataStoreCacheLoader
        </class-name>
      </cache-loader>
    </region-attributes>
  </region>

  <initializer>
    <class-name>org.springframework.data.gemfire.support.SpringContextBootstrappingInitializer</class-name>
    <parameter name="basePackages">
      <string>org.springframework.data.gemfire.support.sample</string>
    </parameter>
  </initializer>

</cache>

14. 示例应用程序

示例应用程序现在维护在 Spring Apache Geode 示例 存储库中。

Spring Data for Apache Geode 项目还包含一个示例应用程序。名为“Hello World”,该示例应用程序演示了如何在 Spring 应用程序中配置和使用 Apache Geode。在运行时,该示例提供了一个 shell,允许您对数据网格运行各种命令。它为不熟悉基本组件或 Spring 和 Apache Geode 概念的开发人员提供了一个极好的起点。

该示例与发行版捆绑在一起,并且基于 Maven。您可以将其导入任何支持 Maven 的 IDE(例如 Spring Tool Suite)或从命令行运行它们。

14.1. Hello World

“Hello World”示例应用程序演示了 Spring Data for Apache Geode 项目的核心功能。它引导 Apache Geode,对其进行配置,对缓存执行任意命令,并在应用程序退出时将其关闭。应用程序的多个实例可以同时启动并协同工作,在没有任何用户干预的情况下共享数据。

在 Linux 下运行
如果您在启动 Apache Geode 或示例时遇到网络问题,请尝试将以下系统属性 java.net.preferIPv4Stack=true 添加到命令行(例如,-Djava.net.preferIPv4Stack=true)。有关替代(全局)修复(尤其是在 Ubuntu 上),请参阅 SGF-28

14.1.1. 启动和停止示例

“Hello World”示例应用程序被设计为一个独立的 Java 应用程序。它具有一个 main 类,可以通过您的 IDE(在 Eclipse 或 STS 中,通过 Run As/Java Application)或通过 Maven 从命令行启动,使用 mvn exec:java。如果类路径设置正确,您也可以直接在生成的工件上使用 java

要停止示例,请在命令行中键入 exit 或按 Ctrl+C 停止 JVM 并关闭 Spring 容器。

14.1.2. 使用示例

启动后,示例将创建一个共享数据网格,并允许您对其发出命令。输出应类似于以下内容

INFO: Created {data-store-name} Cache [Spring {data-store-name} World] v. X.Y.Z
INFO: Created new cache region [myWorld]
INFO: Member xxxxxx:50694/51611 connecting to region [myWorld]
Hello World!
Want to interact with the world ? ...
Supported commands are:

get <key> - retrieves an entry (by key) from the grid
put <key> <value> - puts a new entry into the grid
remove <key> - removes an entry (by key) from the grid
...

例如,要向网格添加新项目,可以使用以下命令

-> Bold Section qName:emphasis level:5, chunks:[put 1 unu] attrs:[role:bold]
INFO: Added [1=unu] to the cache
null
-> Bold Section qName:emphasis level:5, chunks:[put 1 one] attrs:[role:bold]
INFO: Updated [1] from [unu] to [one]
unu
-> Bold Section qName:emphasis level:5, chunks:[size] attrs:[role:bold]
1
-> Bold Section qName:emphasis level:5, chunks:[put 2 two] attrs:[role:bold]
INFO: Added [2=two] to the cache
null
-> Bold Section qName:emphasis level:5, chunks:[size] attrs:[role:bold]
2

可以同时运行多个实例。启动后,新 VM 会自动看到现有区域及其信息,如下例所示

INFO: Connected to Distributed System ['Spring {data-store-name} World'=xxxx:56218/49320@yyyyy]
Hello World!
...

-> Bold Section qName:emphasis level:5, chunks:[size] attrs:[role:bold]
2
-> Bold Section qName:emphasis level:5, chunks:[map] attrs:[role:bold]
[2=two] [1=one]
-> Bold Section qName:emphasis level:5, chunks:[query length = 3] attrs:[role:bold]
[one, two]

我们鼓励您尝试示例,启动(和停止)任意数量的实例,并在一个实例中运行各种命令,看看其他实例如何反应。为了保留数据,至少需要一个实例始终处于活动状态。如果所有实例都关闭,网格数据将被完全销毁。

14.1.3. Hello World 示例说明

“Hello World” 示例使用 Spring XML 和注解来进行配置。初始引导配置是 app-context.xml,它包含在 cache-context.xml 文件中定义的缓存配置,并执行类路径 组件扫描 以查找 Spring 组件

缓存配置定义了 Apache Geode 缓存、区域,以及为了说明目的而添加的 CacheListener,它充当日志记录器。

主要 Bean 是 HelloWorldCommandProcessor,它们依赖于 GemfireTemplate 来与分布式结构交互。这两个类都使用注解来定义它们的依赖项和生命周期回调。

资源

除了本参考文档之外,还有许多其他资源可以帮助您了解如何将 {data-store-product-name} 与 Spring Framework 配合使用。本节列出了这些额外的第三方资源。

附录

附录 A:命名空间参考

<repositories /> 元素

<repositories /> 元素触发 Spring Data 存储库基础设施的设置。最重要的属性是 base-package,它定义了要扫描 Spring Data 存储库接口的包。参见“[repositories.create-instances.spring]”。下表描述了 <repositories /> 元素的属性。

表 6. 属性
名称 描述

base-package

定义要扫描的包,以查找扩展 *Repository(实际接口由特定的 Spring Data 模块确定)的存储库接口,以进行自动检测模式。所有低于配置包的包也将被扫描。允许使用通配符。

repository-impl-postfix

定义后缀以自动检测自定义存储库实现。名称以配置后缀结尾的类将被视为候选者。默认值为 Impl

query-lookup-strategy

确定用于创建查找查询的策略。有关详细信息,请参见“[repositories.query-methods.query-lookup-strategies]”。默认值为 create-if-not-found

named-queries-location

定义要搜索包含外部定义查询的属性文件的位置。

consider-nested-repositories

是否应考虑嵌套的存储库接口定义。默认值为 false

附录 B:填充程序命名空间参考

<populator /> 元素

<populator /> 元素允许通过 Spring Data 存储库基础设施填充数据存储。[1]

表 7. 属性
名称 描述

locations

从哪里找到要读取对象的存储库文件,这些文件将被填充。

附录 C:存储库查询关键字

支持的查询方法主题关键字

下表列出了 Spring Data 存储库查询推导机制通常支持的主题关键字,以表达谓词。请参阅特定于存储的文档以获取支持的关键字的完整列表,因为此处列出的某些关键字可能在特定存储中不受支持。

表 8. 查询主题关键字
关键字 描述

find…Byread…Byget…Byquery…Bysearch…Bystream…By

一般查询方法,通常返回存储库类型、CollectionStreamable 子类型或结果包装器,如 PageGeoResults 或任何其他特定于存储的结果包装器。可以用作 findBy…findMyDomainTypeBy… 或与其他关键字结合使用。

exists…By

存在投影,通常返回 boolean 结果。

count…By

返回数值结果的计数投影。

delete…By, remove…By

删除查询方法,返回无结果(void)或删除计数。

…First<number>…, …Top<number>…

将查询结果限制为前 <number> 个结果。此关键字可以出现在 find(和其他关键字)和 by 之间的主题的任何位置。

…Distinct…

使用 distinct 查询仅返回唯一结果。请查阅特定于存储的文档,了解该功能是否受支持。此关键字可以出现在 find(和其他关键字)和 by 之间的主题的任何位置。

支持的查询方法谓词关键字和修饰符

下表列出了 Spring Data 存储库查询推导机制通常支持的谓词关键字。但是,请查阅特定于存储的文档以获取支持的关键字的准确列表,因为此处列出的某些关键字可能在特定存储中不受支持。

表 9. 查询谓词关键字
逻辑关键字 关键字表达式

AND

And

OR

Or

AFTER

After, IsAfter

BEFORE

Before, IsBefore

CONTAINING

Containing, IsContaining, Contains

BETWEEN

Between, IsBetween

ENDING_WITH

EndingWith, IsEndingWith, EndsWith

EXISTS

Exists

FALSE

False, IsFalse

GREATER_THAN

GreaterThan, IsGreaterThan

GREATER_THAN_EQUALS

GreaterThanEqual, IsGreaterThanEqual

IN

In, IsIn

IS

Is, Equals, (或无关键字)

IS_EMPTY

IsEmpty, Empty

IS_NOT_EMPTY

IsNotEmpty, NotEmpty

IS_NOT_NULL

NotNull, IsNotNull

IS_NULL

Null, IsNull

LESS_THAN

LessThan, IsLessThan

LESS_THAN_EQUAL

LessThanEqual, IsLessThanEqual

LIKE

Like, IsLike

NEAR

Near, IsNear

NOT

Not, IsNot

NOT_IN

NotIn, IsNotIn

NOT_LIKE

NotLike, IsNotLike

REGEX

Regex, MatchesRegex, Matches

STARTING_WITH

StartingWith, IsStartingWith, StartsWith

TRUE

True, IsTrue

WITHIN

Within, IsWithin

除了过滤器谓词之外,还支持以下修饰符列表

表 10. 查询谓词修饰符关键字
关键字 描述

IgnoreCase, IgnoringCase

与谓词关键字一起使用,用于不区分大小写的比较。

AllIgnoreCase, AllIgnoringCase

忽略所有合适属性的大小写。在查询方法谓词中的某个地方使用。

OrderBy…

指定一个静态排序顺序,后跟属性路径和方向(例如 OrderByFirstnameAscLastnameDesc)。

附录 D:存储库查询返回类型

支持的查询返回类型

下表列出了 Spring Data 存储库通常支持的返回类型。但是,请参阅特定于存储的文档以获取支持的返回类型的确切列表,因为此处列出的某些类型可能在特定存储中不受支持。

地理空间类型(例如 GeoResultGeoResultsGeoPage)仅适用于支持地理空间查询的数据存储。某些存储模块可能会定义自己的结果包装器类型。
表 11. 查询返回类型
返回类型 描述

void

表示没有返回值。

基本类型

Java 基本类型。

包装类型

Java 包装类型。

T

一个唯一的实体。期望查询方法最多返回一个结果。如果未找到结果,则返回 null。多个结果将触发 IncorrectResultSizeDataAccessException

Iterator<T>

一个 Iterator

Collection<T>

一个 Collection

List<T>

一个 List

Optional<T>

一个 Java 8 或 Guava Optional。期望查询方法最多返回一个结果。如果未找到结果,则返回 Optional.empty()Optional.absent()。多个结果将触发 IncorrectResultSizeDataAccessException

Option<T>

Scala 或 Vavr 的 Option 类型。语义上与之前描述的 Java 8 的 Optional 相同。

Stream<T>

Java 8 的 Stream

Streamable<T>

Iterable 的一个便利扩展,它直接公开方法来流式传输、映射和过滤结果,并将它们连接起来等。

实现 Streamable 的类型,并接受 Streamable 构造函数或工厂方法参数

公开构造函数或 ….of(…)/….valueOf(…) 工厂方法的类型,该方法接受 Streamable 作为参数。有关详细信息,请参阅 [repositories.collections-and-iterables.streamable-wrapper]

Vavr SeqListMapSet

Vavr 集合类型。有关详细信息,请参阅 [repositories.collections-and-iterables.vavr]

Future<T>

一个 Future。期望方法使用 @Async 进行注释,并要求启用 Spring 的异步方法执行功能。

CompletableFuture<T>

Java 8 的 CompletableFuture。期望方法使用 @Async 进行注释,并要求启用 Spring 的异步方法执行功能。

ListenableFuture

一个 org.springframework.util.concurrent.ListenableFuture。期望方法使用 @Async 进行注释,并要求启用 Spring 的异步方法执行功能。

Slice<T>

一个大小固定的数据块,并指示是否有更多数据可用。需要 Pageable 方法参数。

Page<T>

一个 Slice,包含其他信息,例如结果的总数。需要 Pageable 方法参数。

GeoResult<T>

一个结果条目,包含其他信息,例如到参考位置的距离。

GeoResults<T>

一个 GeoResult<T> 列表,包含其他信息,例如到参考位置的平均距离。

GeoPage<T>

一个 Page,包含 GeoResult<T>,例如到参考位置的平均距离。

Mono<T>

使用响应式存储库,一个 Project Reactor Mono 发射零个或一个元素。预期查询方法最多返回一个结果。如果未找到结果,则返回 Mono.empty()。多个结果将触发 IncorrectResultSizeDataAccessException

Flux<T>

使用响应式存储库,一个 Project Reactor Flux 发射零个、一个或多个元素。返回 Flux 的查询也可以发射无限数量的元素。

Single<T>

使用响应式存储库,一个 RxJava Single 发射单个元素。预期查询方法最多返回一个结果。如果未找到结果,则返回 Mono.empty()。多个结果将触发 IncorrectResultSizeDataAccessException

Maybe<T>

使用响应式存储库,一个 RxJava Maybe 发射零个或一个元素。预期查询方法最多返回一个结果。如果未找到结果,则返回 Mono.empty()。多个结果将触发 IncorrectResultSizeDataAccessException

Flowable<T>

使用响应式存储库,一个 RxJava Flowable 发射零个、一个或多个元素。返回 Flowable 的查询也可以发射无限数量的元素。