Spring Data JDBC - 如何进行聚合根的局部更新?

工程 | Jens Schauder | 2022年1月20日 | ...

这是关于如何解决使用 Spring Data JDBC 时可能遇到的各种挑战的系列文章的第四篇。该系列包括:

  1. Spring Data JDBC - 如何使用自定义 ID 生成。

  2. Spring Data JDBC - 如何实现双向关系?

  3. Spring Data JDBC - 如何实现缓存?

  4. Spring Data JDBC - 如何进行聚合根的局部更新?(本文)

  5. Spring Data JDBC - 如何为我的领域模型生成模式?

如果您不熟悉 Spring Data JDBC,则应首先阅读介绍这篇文章,其中解释了聚合在 Spring Data JDBC 上下文中的相关性。相信我,这很重要。

Spring Data JDBC 是围绕聚合和存储库的概念构建的。存储库是类似集合的对象,用于查找、加载、保存和删除聚合。聚合是具有紧密关系的对象集群,只要程序控制在其方法之外,它们在内部就保持一致。因此,聚合也作为一个原子操作一起加载和持久化。

但是,Spring Data JDBC 不会跟踪聚合如何变化。因此,Spring Data JDBC 持久化聚合的算法最大限度地减少了对数据库状态的假设。如果您的聚合包含多个实体的集合,这将代价高昂。

为了展示会发生什么,我们再次转向小黄人。这个小黄人有一套玩具。

class Minion {

	@Id Long id;
	String name;
	Color color = Color.YELLOW;
	Set<Toy> toys = new HashSet<>();
	@Version int version;

	Minion(String name) {
		this.name = name;
	}

	@PersistenceConstructor
	private Minion(Long id, String name, Collection<Toy> toys, int version) {

		this.id = id;
		this.name = name;
		this.toys.addAll(toys);
		this.version = version;
	}

	Minion addToy(Toy toy) {

		toys.add(toy);
		return this;
	}
}

这些类的模式如下所示

CREATE TABLE MINION
(
    ID             IDENTITY PRIMARY KEY,
    NAME           VARCHAR(255),
    COLOR          VARCHAR(10),
    VERSION      INT
);

CREATE TABLE TOY
(
    MINION  BIGINT NOT NULL,
    NAME    VARCHAR(255)
);

目前,存储库接口很简单

interface MinionRepository extends CrudRepository<Minion, Long> {}

如果我们保存一个已经存在于数据库中的小黄人,则会发生以下情况:

  1. 数据库中小黄人的所有玩具都会被删除。

  2. 小黄人本身会更新。

  3. 当前属于该小黄人的所有玩具都会插入到数据库中。

当有很多玩具并且没有任何玩具被更改、删除或添加时,这是浪费的。但是,Spring Data JDBC 没有关于这方面的信息,也不应该有,以保持其简单性。此外,您在代码中可能比 Spring Data 或任何其他工具或库知道的更多,您可以利用这些知识。接下来的部分将描述多种执行此操作的方法。

使用聚合根的简化视图

玩具是任何合格小黄人不可或缺的一部分,但也许有些领域并不关心玩具。如果是这样,使用映射到同一表的PlainMinion 没有任何问题

@Table("MINION")
class PlainMinion {
	@Id Long id;
	String name;
	@Version int version;
}

因为它不知道玩具,所以它会忽略它们,您可以通过测试来验证这一点。

@SpringBootTest
class SelectiveUpdateApplicationTests {

	@Autowired MinionRepository minions;
	@Autowired PlainMinionRepository plainMinions;

	@Test
	void renameWithReducedView() {

		Minion bob = new Minion("Bob")
				.addToy(new Toy("Tiger Duck"))
				.addToy(new Toy("Security blanket"));
		minions.save(bob);

		PlainMinion plainBob = plainMinions.findById(bob.id).orElseThrow();
		plainBob.name = "Bob II.";
		plainMinions.save(plainBob);

		Minion bob2 = minions.findById(bob.id).orElseThrow();

		assertThat(bob2.toys).containsExactly(bob.toys.toArray(new Toy[]{}));
	}
}

只需确保玩具和小黄人之间存在外键,这样您就不会意外地删除小黄人而不会同时删除其玩具。此外,这仅适用于聚合根。聚合内的实体会被删除和重新创建,因此在简化视图中不存在的任何列都会重置为其默认值。

使用直接数据库更新

或者,您可以只在一个新的存储库方法中编写您的更新

interface MinionRepository extends CrudRepository<Minion, Long> {

	@Modifying
	@Query("UPDATE MINION SET COLOR ='PURPLE', VERSION = VERSION +1 WHERE ID = :id")
	void turnPurple(Long id);
}

您需要注意的是,它绕过了 Spring Data JDBC 中的任何逻辑。您必须确保这不会对您的应用程序造成问题。此类逻辑的一个示例是乐观锁。上面的语句处理了乐观锁,因此其他处理小黄人的进程不会意外地撤消颜色更改。同样,如果您的实体具有审计列,您需要确保它们也会相应更新。如果您使用生命周期事件实体回调,则需要考虑是否以及如何模拟其操作。

使用自定义方法

许多 Spring Data 用户经常忽略的一个替代方案是实现自定义方法的选项,您可以在其中编写任何您想要或需要的代码。

为此,您可以让您的存储库扩展一个接口以包含您想要实现的方法

interface MinionRepository extends CrudRepository<Minion, Long>, PartyHatRepository {}

interface PartyHatRepository {

	void addPartyHat(Minion minion);
}

然后为它提供一个具有相同名称但添加了Impl 的实现

class PartyHatRepositoryImpl implements PartyHatRepository {

	private final NamedParameterJdbcOperations template;

	public PartyHatRepositoryImpl(NamedParameterJdbcOperations template) {
		this.template = template;
	}

	@Override
	public void addPartyHat(Minion minion) {

		Map<String, Object> insertParams = new HashMap<>();
		insertParams.put("id", minion.id);
		insertParams.put("name", "Party Hat");
		template.update("INSERT INTO TOY (MINION, NAME) VALUES (:id, :name)", insertParams);

		Map<String, Object> updateParams = new HashMap<>();
		updateParams.put("id", minion.id);
		updateParams.put("version", minion.version);
		final int updateCount = template.update("UPDATE MINION SET VERSION = :version + 1 WHERE ID = :id AND VERSION = :version", updateParams);
		if (updateCount != 1) {
			throw new OptimisticLockingFailureException("Minion was changed before a Party Hat was given");
		}
	}
}

在我们的示例中,我们执行多个 SQL 语句来添加一个玩具,并确保使用乐观锁

@Test
void grantPartyHat() {

  Minion bob = new Minion("Bob")
      .addToy(new Toy("Tiger Duck"))
      .addToy(new Toy("Security blanket"));
  minions.save(bob);

  minions.addPartyHat(bob);

  Minion bob2 = minions.findById(bob.id).orElseThrow();

  assertThat(bob2.toys).extracting("name").containsExactlyInAnyOrder("Tiger Duck", "Security blanket", "Party Hat");
  assertThat(bob2.name).isEqualTo("Bob");
  assertThat(bob2.color).isEqualTo(Color.YELLOW);
  assertThat(bob2.version).isEqualTo(bob.version+1);

  assertThatExceptionOfType(OptimisticLockingFailureException.class).isThrownBy(() -> minions.addPartyHat(bob));
}

结论

Spring Data JDBC 旨在在标准情况下让您的生活更轻松。同时,如果您希望某些内容的行为有所不同,它也不会妨碍您。您可以选择多个级别来实现所需的行为。

完整的示例代码可在Spring Data 示例存储库中找到。

还会有更多类似的文章。如果您希望我涵盖特定主题,请告诉我。

获取 Spring 新闻通讯

通过 Spring 新闻通讯保持联系

订阅

领先一步

VMware 提供培训和认证,以加快您的进度。

了解更多

获得支持

Tanzu Spring 在一个简单的订阅中提供对 OpenJDK™、Spring 和 Apache Tomcat® 的支持和二进制文件。

了解更多

即将举行的活动

查看 Spring 社区中所有即将举行的活动。

查看全部