由于軟件應(yīng)用程序的不斷變化的性質(zhì)邢锯,很可能事件定義也隨著時(shí)間而變化。由于事件存儲(chǔ)被認(rèn)為是只讀和只追加(沒有修改和刪除)的數(shù)據(jù)源,所以應(yīng)用程序必須能夠讀取所有事件,而不管它們何時(shí)添加狐蜕。這時(shí)upcasting 出現(xiàn)了。
最初是面向?qū)ο缶幊痰囊粋€(gè)概念卸夕,“一個(gè)子類在需要的時(shí)候自動(dòng)轉(zhuǎn)換成超類”层释,upcasting 概念也可以應(yīng)用于事件溯源。upcast一個(gè)事件意味著將它從原來的結(jié)構(gòu)轉(zhuǎn)換成新的結(jié)構(gòu)快集。不像OOP的upcasting贡羔,事件的upcasting無法全部自動(dòng)化完成,因?yàn)榕f的事件對新事件的結(jié)構(gòu)是不了解的碍讨。手工編寫的Upcasters治力,必須提供指定如何將舊的結(jié)構(gòu)upcast成新結(jié)構(gòu)蒙秒。
Upcasters類勃黍,獲取一個(gè)x版本的輸入事件,并且輸出為零或更多版本x+1的新事件晕讲。此外覆获,upcasters在一個(gè)鏈中被處理马澈,這意味著一個(gè)upcaster的輸出發(fā)送到下一個(gè)upcaster的輸入。這允許你以增量的方式更新事件弄息,為每一個(gè)新事件版次編寫一個(gè)Upcaster 痊班,使其小、隔離摹量、并且容易理解涤伐。
注意
也許upcasting最大的好處是,它允許你做非破壞性重構(gòu)缨称,即完整的事件歷史仍然保持不變凝果。
在本節(jié)中,我們將解釋如何編寫upcaster睦尽,描述隨著Axon不同的的Upcaster實(shí)現(xiàn)器净,并解釋事件的序列化形式如何影響寫upcasters。
允許upcaster看到什么版本的序列化對象被接收当凡,Event Store存儲(chǔ)版本號以及事件的完全限定名稱山害。這個(gè)版本號是由RevisionResolver生成,在序列化器中配置。Axon提供了幾個(gè)RevisionResolver的實(shí)現(xiàn)沿量,比如AnnotationRevisionResolver浪慌,它檢查在事件有效負(fù)載上的@Revision注解,SerialVersionUIDRevisionResolver 使用Java Serialization API和FixedValueRevisionResolver所定義的serialVersionUID朴则,它總是返回一個(gè)預(yù)定義的值眷射。后者在注入當(dāng)前應(yīng)用程序版本時(shí)是有用的。這將允許你看哪個(gè)版本的應(yīng)用程序生成一個(gè)特定的事件佛掖。
Maven用戶可以使用MavenArtifactRevisionResolver自動(dòng)使用項(xiàng)目的版本妖碉。它使用項(xiàng)目獲取的groupId,artifactId版本初始化芥被。因?yàn)檫@只適用由Maven創(chuàng)建的JAR文件,版本不總能通過IDE來解析欧宜。如果無法解析版本,則返回null拴魄。
編寫一個(gè)upcaster
事件的老版本:
@Revision("1.0")
public class ComplaintEvent {
private String id;
private String companyName;
// Constructor, getter, setter...
}
新版本的事件:
@Revision("2.0")
public class ComplaintEvent {
private String id;
private String companyName;
private String complain; // New field
// Constructor, getter, setter...
}
Upcaster:
// Upcaster from 1.0 revision to 2.0 revision
public class ComplaintEventUpcaster extends SingleEventUpcaster {
private static SimpleSerializedType targetType = new SimpleSerializedType(ComplainEvent.class.getTypeName(), "1.0");
@Override
protected boolean canUpcast(IntermediateEventRepresentation intermediateRepresentation) {
return intermediateRepresentation.getType().equals(targetType);
}
@Override
protected IntermediateEventRepresentation doUpcast(IntermediateEventRepresentation intermediateRepresentation) {
return intermediateRepresentation.upcastPayload(
new SimpleSerializedType(targetType.getName(), "2.0"),
org.dom4j.Document.class,
document -> {
document.getRootElement().addElement("complaint");
document.getRootElement().element("complaint").setText("no complaint description"); // Default value
return document;
}
);
}
}
Spring boot configuration:
@Configuration
public class AxonConfiguration {
@Bean
public SingleEventUpcaster myUpcaster() {
return new ComplaintEventUpcaster();
}
@Bean
public JpaEventStorageEngine eventStorageEngine(Serializer serializer,
DataSource dataSource,
SingleEventUpcaster myUpcaster,
EntityManagerProvider entityManagerProvider,
TransactionManager transactionManager) throws SQLException {
return new JpaEventStorageEngine(serializer,
myUpcaster::upcast,
dataSource,
entityManagerProvider,
transactionManager);
}
}
TODO - Describe
- Upcasters工作在中間的表現(xiàn)層
- 它們更新流到流
- 抽象一對一的upcasting實(shí)現(xiàn)
- 代碼示例
Content type conversion(內(nèi)容類型轉(zhuǎn)換)
一個(gè)upcaster工作在給定內(nèi)容類型上(如dom4j文檔)冗茸。upcasters之間提供額外的靈活性,內(nèi)容類型在鏈接的upcasters之間可能會(huì)有所不同匹中。Axon將嘗試使用ContentTypeConverters在內(nèi)容類型之間自動(dòng)地轉(zhuǎn)換夏漱。它將尋找從類型x到類型y最短的路徑,執(zhí)行轉(zhuǎn)換并交值轉(zhuǎn)換成請求的upcaster顶捷」掖拢考慮到性能因素 ,如果receiving upcaster上的canUpcast方法產(chǎn)生true服赎,轉(zhuǎn)換才會(huì)被執(zhí)行
ContentTypeConverters可能依賴于使用的序列化器類型葵蒂。試圖把一個(gè)byte[]轉(zhuǎn)換成dom4j文檔交播,這沒有任何意義,除非使用序列化器把事件作為XML來寫践付。確保UpcasterChain有權(quán)訪問serializer-specific ContentTypeConverters,你可以通過UpcasterChain的構(gòu)造函數(shù)引用序列化器秦士。
提示
為了達(dá)到最佳性能,確保所有upcasters在同一鏈上(其中一個(gè)的輸出是另一個(gè)的輸入)處理相同的內(nèi)容類型。
如果你需要不是由Axon提供的內(nèi)容類型轉(zhuǎn)換永高,你可以使用ContentTypeConverter接口編寫一個(gè)自己的隧土。
XStreamSerializer支持Dom4J像支持 XOM一樣作為XML文檔表示。JacksonSerializer 支持Jackson的JsonNode命爬。