Spring Data JDBC - 如何对聚合根进行部分更新？

我会带着你远行 2023-09-25 12:41 42阅读 0赞

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

1.  [Spring Data JDBC - 如何使用自定义 ID 生成。][Spring Data JDBC - _ ID]
2.  [Spring Data JDBC - 如何建立双向关系？][Spring Data JDBC -]
3.  [Spring Data JDBC - 如何实现缓存？][Spring Data JDBC - 1]
4.  Spring Data JDBC - 如何对聚合根进行部分更新？（本文）

如果你是Spring Data JDBC的新手，你应该从阅读开始[介绍][Link 1]和[本文解释了聚合在 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中的任何逻辑。 必须确保这不会给应用程序带来问题。 这种逻辑的一个例子是乐观锁定。 上面的语句负责乐观锁定，因此对工作节点执行其他操作的其他进程不会意外撤消颜色更改。 同样，如果您的实体具有审核列，则需要确保它们相应地更新。 如果您使用[生命周期事件][Link 2]或[实体回调][Link 3]，您需要考虑是否以及如何模仿他们的行动。

### 使用自定义方法 ###

许多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 数据示例存储库][Spring].

[Spring Data JDBC - _ ID]: https://spring.io/blog/2021/09/09/spring-data-jdbc-how-to-use-custom-id-generation
[Spring Data JDBC -]: https://spring.io/blog/2021/09/22/spring-data-jdbc-how-do-i-make-bidirectional-relationships
[Spring Data JDBC - 1]: https://spring.io/blog/2021/10/18/spring-data-jdbc-how-do-i-implement-caching
[Link 1]: https://spring.io/blog/2018/09/17/introducing-spring-data-jdbc
[Spring Data JDBC]: https://spring.io/blog/2018/09/24/spring-data-jdbc-references-and-aggregates
[Link 2]: https://docs.spring.io/spring-data/jdbc/docs/current/reference/html/#jdbc.events
[Link 3]: https://docs.spring.io/spring-data/jdbc/docs/current/reference/html/#jdbc.entity-callbacks
[Spring]: https://github.com/spring-projects/spring-data-examples/tree/main/jdbc/howto/selectiveupdate