如何基于Axon Framework、Spring Boot实现MongoDB分库多租户事件存储?
基于Axon Framework 4.1.1与axon-mongodb扩展,实现“每租户独立Mongo数据库”模式的多租户事件存储完全可行,且不需要修改Axon核心逻辑或重写事件存储类的读写方法。
你之前尝试在事件存储类中找可重写方法追加租户ID的思路方向存在偏差:axon-mongodb扩展在该版本默认将Mongo连接绑定到固定单库,未内置多租户路由能力,核心改造点是替换底层Mongo连接的数据库路由逻辑,而非修改事件存储本身的读写流程。
整个链路的逻辑拆解为两层:
- 第一层:打通全链路的租户ID透传机制,保证从入口请求到Axon命令/事件/Saga的异步处理流程中,当前租户ID可以被实时获取
- 第二层:替换默认的固定单库Mongo连接逻辑,根据当前实时获取的租户ID,动态路由到对应租户的独立Mongo数据库,所有事件的读写操作全部走该动态路由连接
只要两层逻辑打通,Axon原有事件存储的所有读写能力都会自动适配多租户场景,不需要单独修改事件存储代码。
1. 租户上下文基础组件
首先提供全局租户ID存取的基础能力,用于在当前执行流中传递租户标识:
public class TenantContext { private static final ThreadLocal<String> CURRENT_TENANT = new ThreadLocal<>(); public static void setTenantId(String tenantId) { CURRENT_TENANT.set(tenantId); } public static String getTenantId() { return CURRENT_TENANT.get(); } public static void clear() { CURRENT_TENANT.remove(); } }
该组件需要在Spring MVC请求拦截器、Axon消息处理拦截器中做自动的ID填充与上下文清理,避免租户ID串线。
2. 租户感知的Mongo数据库路由工厂
替换Spring Data MongoDB默认的固定库连接工厂,实现根据当前租户ID动态获取目标Mongo数据库的逻辑:
public class TenantAwareMongoDbFactory implements MongoDbFactory { // 复用同一个Mongo集群连接实例,不同租户的独立库在同一集群下 private final MongoClient mongoClient; // 系统兜底默认数据库,用于非租户场景的公共数据存储 private final String defaultDatabase; public TenantAwareMongoDbFactory(MongoClient mongoClient, String defaultDatabase) { this.mongoClient = mongoClient; this.defaultDatabase = defaultDatabase; } @Override public MongoDatabase getDb() throws DataAccessException { String currentTenantId = TenantContext.getTenantId(); // 有租户上下文时路由到对应独立库,无上下文时使用默认系统库 String targetDbName = currentTenantId != null ? "tenant_" + currentTenantId : defaultDatabase; return mongoClient.getDatabase(targetDbName); } @Override public MongoDatabase getDb(String dbName) throws DataAccessException { return mongoClient.getDatabase(dbName); } @Override public void destroy() { mongoClient.close(); } }
其余MongoDbFactory接口的方法可以按需委托给默认实现完成,不影响核心路由逻辑。注意:必须将该自定义工厂注册为Spring Bean,优先级高于自动配置生成的默认单库DbFactory,避免原有逻辑覆盖自定义路由能力。
3. 适配Axon事件存储的动态路由配置
4.1.1版本的MongoEventStorageEngine本身依赖MongoTemplate完成所有事件读写,我们只需要将绑定了动态DbFactory的MongoTemplate注入到事件存储引擎中,即可实现事件的自动租户路由:
@Configuration public class MultiTenantAxonConfig { private final MongoClient mongoClient; public MultiTenantAxonConfig(MongoClient mongoClient) { this.mongoClient = mongoClient; } @Bean public TenantAwareMongoDbFactory tenantMongoDbFactory() { // 配置系统兜底库名为axon_system return new TenantAwareMongoDbFactory(mongoClient, "axon_system"); } @Bean public MongoTemplate tenantRoutingMongoTemplate(TenantAwareMongoDbFactory dbFactory) { return new MongoTemplate(dbFactory); } @Bean public EventStorageEngine multiTenantEventStorageEngine( MongoTemplate tenantRoutingMongoTemplate, Serializer eventSerializer ) { // 完全复用原生MongoEventStorageEngine能力,仅替换底层连接的路由逻辑 return MongoEventStorageEngine.builder() .mongoTemplate(tenantRoutingMongoTemplate) .eventSerializer(eventSerializer) .build(); } }
该配置生成的事件存储引擎会完全替换axon-mongodb扩展自动配置生成的单库事件存储,所有事件追加、事件流读取、事件快照存储的操作,都会通过动态路由连接自动写入/读取当前租户对应的独立Mongo数据库。
4. Axon链路的租户ID全透传补全
因为Axon存在异步事件处理、Saga异步执行等线程切换场景,仅靠请求入口的上下文存储无法保证租户ID不丢失,需要实现全局消息拦截器,将租户ID存入事件消息的元数据中,在处理端再还原到上下文:
@Component public class TenantPropagateInterceptor implements MessageDispatchInterceptor<Message<?>>, MessageHandlerInterceptor<Message<?>> { public static final String TENANT_META_KEY = "currentTenantId"; // 消息发送前,将当前线程的租户ID写入消息元数据 @Nonnull @Override public BiFunction<Integer, Message<?>, Message<?>> handle(@Nonnull List<? extends Message<?>> messages) { String currentTenant = TenantContext.getTenantId(); return (index, message) -> { if (currentTenant != null && !message.getMetaData().containsKey(TENANT_META_KEY)) { return message.andMetaData(Collections.singletonMap(TENANT_META_KEY, currentTenant)); } return message; }; } // 消息处理前,从元数据还原租户ID到上下文,处理完成后清理 @Override public Object handle(@Nonnull UnitOfWork<? extends Message<?>> unitOfWork, @Nonnull InterceptorChain interceptorChain) throws Exception { Object tenantId = unitOfWork.getMessage().getMetaData().get(TENANT_META_KEY); try { if (tenantId != null) { TenantContext.setTenantId(tenantId.toString()); } return interceptorChain.proceed(); } finally { TenantContext.clear(); } } }
最后将该拦截器注册到Axon全局配置中,覆盖命令总线、事件总线、查询总线、Saga处理器的全链路拦截,即可保证租户ID在线程切换、异步处理场景下不丢失。
- 不要在DbFactory初始化时将目标库名写死,必须在每次
getDb()方法调用时实时从租户上下文获取目标库名,否则会出现所有请求都路由到第一次初始化时的数据库的问题 - 新租户上线时需要实现自动的库初始化逻辑,提前创建对应租户的Mongo数据库,并初始化事件存储依赖的固定集合(domainEvents、snapshotEvents等)
- 为每个租户库配置独立的访问权限,实现租户间的数据权限隔离
内容的提问来源于stack exchange,提问作者Srinivasula Reddy

