对于最新的稳定版本，请使用 Spring Data Cassandra 4.3.1！Spring中文文档

对于最新的稳定版本，请使用 Spring Data Cassandra 4.3.1！Spring中文文档

Apache Cassandra 是一种数据存储，在任何数据交互之前都需要架构定义。 Spring Data for Apache Cassandra 可以支持您创建架构。Spring中文文档

键空间和生命周期脚本

首先要开始的是 Cassandra 密钥空间。 键空间是共享相同复制因子和复制策略的表的逻辑分组。 密钥空间管理位于配置中，该配置具有启动和关闭 CQL 脚本执行。CqlSessionKeyspaceSpecificationSpring中文文档

使用规范声明密钥空间允许创建和删除密钥空间。 它从规范派生 CQL，因此您无需自己编写 CQL。 以下示例使用 XML 指定 Cassandra 密钥空间：Spring中文文档

例 1.指定 Cassandra 密钥空间
爪哇岛
@Configuration
public class CreateKeyspaceConfiguration extends AbstractCassandraConfiguration implements BeanClassLoaderAware {

	@Override
	protected List<CreateKeyspaceSpecification> getKeyspaceCreations() {

		CreateKeyspaceSpecification specification = CreateKeyspaceSpecification.createKeyspace("my_keyspace")
				.with(KeyspaceOption.DURABLE_WRITES, true)
				.withNetworkReplication(DataCenterReplication.of("foo", 1), DataCenterReplication.of("bar", 2));

		return Arrays.asList(specification);
	}

	@Override
	protected List<DropKeyspaceSpecification> getKeyspaceDrops() {
		return Arrays.asList(DropKeyspaceSpecification.dropKeyspace("my_keyspace"));
	}

	// ...
}
XML格式
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:cassandra="http://www.springframework.org/schema/data/cassandra"
  xsi:schemaLocation="
    http://www.springframework.org/schema/data/cassandra
    https://www.springframework.org/schema/data/cassandra/spring-cassandra.xsd
    http://www.springframework.org/schema/beans
    https://www.springframework.org/schema/beans/spring-beans.xsd">

    <cassandra:session>

        <cassandra:keyspace action="CREATE_DROP" durable-writes="true" name="my_keyspace">
            <cassandra:replication class="NETWORK_TOPOLOGY_STRATEGY">
              <cassandra:data-center name="foo" replication-factor="1" />
              <cassandra:data-center name="bar" replication-factor="2" />
            </cassandra:replication>
      </cassandra:keyspace>

    </cassandra:session>
</beans>
密钥空间创建允许快速引导，而无需外部密钥空间管理。 这在某些情况下可能很有用，但应谨慎使用。 在应用程序关闭时删除密钥空间会从密钥空间中的表中删除密钥空间和所有数据。
密钥空间创建允许快速引导，而无需外部密钥空间管理。 这在某些情况下可能很有用，但应谨慎使用。 在应用程序关闭时删除密钥空间会从密钥空间中的表中删除密钥空间和所有数据。

初始化SessionFactory

该软件包支持初始化现有的 . 有时可能需要初始化在某处服务器上运行的密钥空间。org.springframework.data.cassandra.core.cql.session.initSessionFactorySpring中文文档

初始化密钥空间

您可以在配置的密钥空间中提供在初始化和关闭时执行的任意 CQL，如以下 Java 配置示例所示：CqlSessionSpring中文文档

爪哇岛
@Configuration
public class KeyspacePopulatorConfiguration extends AbstractCassandraConfiguration {

	@Nullable
	@Override
	protected KeyspacePopulator keyspacePopulator() {
		return new ResourceKeyspacePopulator(new ClassPathResource("com/foo/cql/db-schema.cql"),
				new ClassPathResource("com/foo/cql/db-test-data.cql"));
	}

	@Nullable
	@Override
	protected KeyspacePopulator keyspaceCleaner() {
		return new ResourceKeyspacePopulator(scriptOf("DROP TABLE my_table;"));
	}

	// ...
}
XML格式
<cassandra:initialize-keyspace session-factory-ref="cassandraSessionFactory">
    <cassandra:script location="classpath:com/foo/cql/db-schema.cql"/>
    <cassandra:script location="classpath:com/foo/cql/db-test-data.cql"/>
</cassandra:initialize-keyspace>

前面的示例针对密钥空间运行两个指定的脚本。 第一个脚本创建一个架构，第二个脚本使用测试数据集填充表。 脚本位置也可以是带有通配符的模式，采用 Spring 中用于资源的通常 Ant 样式（例如，）。 如果使用模式，则脚本将按其 URL 或文件名的词法顺序运行。classpath*:/com/foo/**/cql/*-data.cqlSpring中文文档

密钥空间初始值设定项的缺省行为是无条件运行提供的脚本。 这可能并不总是您想要的 - 例如，如果您针对已包含测试数据的密钥空间运行脚本。 通过遵循先创建表然后插入数据的常见模式（如前所示），可以降低意外删除数据的可能性。 如果表已存在，则第一步将失败。Spring中文文档

但是，为了更好地控制现有数据的创建和删除，XML 命名空间提供了一些附加选项。 第一个是用于打开和关闭初始化的标志。 您可以根据环境进行设置（例如，从系统属性或环境 Bean 中提取布尔值）。 下面的示例从系统属性中获取一个值：Spring中文文档

<cassandra:initialize-keyspace session-factory-ref="cassandraSessionFactory"
    enabled="#{systemProperties.INITIALIZE_KEYSPACE}">    (1)
    <cassandra:script location="..."/>
</cassandra:initialize-database>
1 从名为 的系统属性中获取 的值。enabledINITIALIZE_KEYSPACE

控制现有数据发生情况的第二种选择是更宽容地容忍故障。 为此，您可以控制初始值设定项忽略它从脚本执行的 CQL 中的某些错误的能力，如以下示例所示：Spring中文文档

爪哇岛
@Configuration
public class KeyspacePopulatorFailureConfiguration extends AbstractCassandraConfiguration {

	@Nullable
	@Override
	protected KeyspacePopulator keyspacePopulator() {

		ResourceKeyspacePopulator populator = new ResourceKeyspacePopulator(
				new ClassPathResource("com/foo/cql/db-schema.cql"));

		populator.setIgnoreFailedDrops(true);

		return populator;
	}

	// ...
}
XML格式
<cassandra:initialize-keyspace session-factory-ref="cassandraSessionFactory" ignore-failures="DROPS">
    <cassandra:script location="..."/>
</cassandra:initialize-database>

在前面的示例中，我们说我们期望脚本有时针对空键空间运行，因此脚本中的某些语句会失败。 因此，失败的 CQL 语句将被忽略，但其他失败将导致异常。 如果您不希望使用支持（或类似支持），但又希望在重新创建之前无条件删除所有测试数据，这将非常有用。 在这种情况下，第一个脚本通常是一组语句，然后是一组语句。DROPDROPDROP …​ IF EXISTSDROPCREATESpring中文文档

该选项可以设置为（默认值）、（忽略失败的丢弃）或（忽略所有失败）。ignore-failuresNONEDROPSALLSpring中文文档

如果字符在脚本中根本不存在，则每个语句都应用新行分隔或换行。 您可以全局控制该命令，也可以按脚本控制该命令，如以下示例所示：;;Spring中文文档

爪哇岛
@Configuration
public class SessionFactoryInitializerConfiguration extends AbstractCassandraConfiguration {

	@Bean
	SessionFactoryInitializer sessionFactoryInitializer(SessionFactory sessionFactory) {

		SessionFactoryInitializer initializer = new SessionFactoryInitializer();
		initializer.setSessionFactory(sessionFactory);

		ResourceKeyspacePopulator populator1 = new ResourceKeyspacePopulator();
		populator1.setSeparator(";");
		populator1.setScripts(new ClassPathResource("com/myapp/cql/db-schema.cql"));

		ResourceKeyspacePopulator populator2 = new ResourceKeyspacePopulator();
		populator2.setSeparator("@@");
		populator2.setScripts(new ClassPathResource("classpath:com/myapp/cql/db-test-data-1.cql"), //
				new ClassPathResource("classpath:com/myapp/cql/db-test-data-2.cql"));

		initializer.setKeyspacePopulator(new CompositeKeyspacePopulator(populator1, populator2));

		return initializer;
	}

	// ...
}
XML格式
<cassandra:initialize-keyspace session-factory-ref="cassandraSessionFactory" separator="@@">
    <cassandra:script location="classpath:com/myapp/cql/db-schema.cql" separator=";"/>
    <cassandra:script location="classpath:com/myapp/cql/db-test-data-1.cql"/>
    <cassandra:script location="classpath:com/myapp/cql/db-test-data-2.cql"/>
</cassandra:initialize-keyspace>

在此示例中，两个脚本用作语句分隔符，并且仅使用 . 此配置指定默认分隔符，并覆盖脚本的默认分隔符。test-data@@db-schema.cql;@@db-schemaSpring中文文档

如果需要的控制比从 XML 命名空间获得的控制更多，则可以直接使用 并将其定义为应用程序中的组件。SessionFactoryInitializerSpring中文文档

依赖于密钥空间的其他组件的初始化

一大类应用程序（那些在 Spring 上下文启动之前不使用数据库的应用程序）可以使用数据库初始值设定项，而不会出现进一步的复杂情况。 如果您的应用程序不是其中之一，则可能需要阅读本节的其余部分。Spring中文文档

数据库初始值设定项依赖于实例并运行其初始化回调中提供的脚本（类似于 XML Bean 定义中的方法、组件中的方法或实现 的组件中的方法）。 如果其他 Bean 依赖于相同的数据源，并且在初始化回调中使用会话工厂，则可能存在问题，因为数据尚未初始化。 一个常见的示例是缓存，该缓存在应用程序启动时急切地初始化并从数据库加载数据。SessionFactoryinit-method@PostConstructafterPropertiesSet()InitializingBeanSpring中文文档

要解决此问题，您有两种选择：将缓存初始化策略更改为稍后阶段，或者确保首先初始化密钥空间初始值设定项。Spring中文文档

如果应用程序由您控制，则更改缓存初始化策略可能很容易，否则则不然。 有关如何实现这一点的一些建议包括：Spring中文文档

  • 使缓存在首次使用时延迟初始化，从而缩短应用程序启动时间。Spring中文文档

  • 让缓存或初始化缓存的单独组件实现或 . 当应用程序上下文启动时，可以通过设置其标志来自动启动 a，也可以通过调用封闭上下文来手动启动 a。LifecycleSmartLifecycleSmartLifecycleautoStartupLifecycleConfigurableApplicationContext.start()Spring中文文档

  • 使用 Spring 或类似的自定义观察器机制来触发缓存初始化。 当它准备好使用时（在所有 Bean 都初始化之后），它总是由上下文发布，因此这通常是一个有用的钩子（这是默认的工作方式）。ApplicationEventContextRefreshedEventSmartLifecycleSpring中文文档

确保首先初始化密钥空间初始值设定项也很容易。 关于如何实现这一点的一些建议包括：Spring中文文档

  • 依赖 Spring 的默认行为，即 Bean 按注册顺序初始化。 通过采用 XML 配置中一组元素的常见做法，对应用程序模块进行排序，并确保首先列出数据库和数据库初始化，可以很容易地安排它。BeanFactory<import/>Spring中文文档

  • 将使用它的业务组件分开，并通过将它们放在单独的实例中来控制它们的启动顺序（例如，父上下文包含 ，子上下文包含业务组件）。 这种结构在 Spring Web 应用程序中很常见，但可以更普遍地应用。SessionFactoryApplicationContextSessionFactorySpring中文文档

  • 使用表和用户定义类型的架构管理，使用 Spring Data Cassandra 的内置架构生成器初始化密钥空间。Spring中文文档

1 从名为 的系统属性中获取 的值。enabledINITIALIZE_KEYSPACE

表和用户定义类型

Spring Data for Apache Cassandra 使用适合您的数据模型的映射实体类进行数据访问。 您可以使用这些实体类来创建 Cassandra 表规范和用户类型定义。Spring中文文档

架构创建与初始化相关联。 支持以下操作：CqlSessionSchemaActionSpring中文文档

  • SchemaAction.NONE：不会创建或删除任何表或类型。 这是默认设置。Spring中文文档

  • SchemaAction.CREATE：从用 批注的实体和用 批注的类型创建表、索引和用户定义类型。 如果尝试创建现有表或类型，则会导致错误。@Table@UserDefinedTypeSpring中文文档

  • SchemaAction.CREATE_IF_NOT_EXISTS：喜欢但应用。 现有表或类型不会导致任何错误，但可能会保持陈旧状态。SchemaAction.CREATEIF NOT EXISTSSpring中文文档

  • SchemaAction.RECREATE：删除并重新创建已知要使用的现有表和类型。 不会删除未在应用程序中配置的表和类型。Spring中文文档

  • SchemaAction.RECREATE_DROP_UNUSED：删除所有表和类型，仅重新创建已知的表和类型。Spring中文文档

SchemaAction.RECREATE并删除您的表并丢失所有数据。 还会删除应用程序不知道的表和类型。SchemaAction.RECREATE_DROP_UNUSEDRECREATE_DROP_UNUSED

为架构管理启用表和用户定义类型

基于元数据的映射解释了使用约定和注释的对象映射。 为了防止将不需要的类创建为表或类型，架构管理仅对用 批注的实体和用 批注的用户定义类型处于活动状态。 实体是通过扫描类路径来发现的。 实体扫描需要一个或多个基础包。 使用的元组类型列不提供任何类型详细信息。 因此，必须对此类列属性进行批注，以指定所需的列类型。@Table@UserDefinedTypeTupleValue@CassandraType(type = TUPLE, typeArguments = …)Spring中文文档

下面的示例演示如何在 XML 配置中指定实体基础包：Spring中文文档

例 2.指定实体基础包
爪哇岛
@Configuration
public class EntityBasePackagesConfiguration extends AbstractCassandraConfiguration {

	@Override
	public String[] getEntityBasePackages() {
		return new String[] { "com.foo", "com.bar" };
	}

	// ...
}
XML格式
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:cassandra="http://www.springframework.org/schema/data/cassandra"
  xsi:schemaLocation="
    http://www.springframework.org/schema/data/cassandra
    https://www.springframework.org/schema/data/cassandra/spring-cassandra.xsd
    http://www.springframework.org/schema/beans
    https://www.springframework.org/schema/beans/spring-beans.xsd">

    <cassandra:mapping entity-base-packages="com.foo,com.bar"/>
</beans>
SchemaAction.RECREATE并删除您的表并丢失所有数据。 还会删除应用程序不知道的表和类型。SchemaAction.RECREATE_DROP_UNUSEDRECREATE_DROP_UNUSED