Grails 3.3.18动态添加租户后无法访问领域对象问题

你基于Grails 3.3.18开发Schema-per-tenant模式的多租户应用，动态添加租户时Schema创建成功，但读取该租户数据时触发错误：

Either class [contacts.Contact] is not a domain class or GORM has not been initialized correctly or has already been shutdown. Ensure GORM is loaded and configured correctly before calling any methods on a GORM entity.

静态配置的Schema（如tenant00）可正常使用，但通过HibernateDatastore.addTenantForSchema动态添加的租户无法读取数据。

1. 手动初始化动态租户的域类映射 #

addTenantForSchema仅完成租户ID与Schema的关联，不会自动初始化GORM域类的Hibernate映射——静态租户在应用启动时已完成映射初始化，动态租户需手动触发：

HibernateDatastore registerTenantDatastore(Company company) {
    String tenantId = company.tenantId
    hibernateDatastore.addTenantForSchema(tenantId)
    
    // 初始化租户的SessionFactory与域类映射
    def sessionFactory = hibernateDatastore.sessionFactory
    def tenantSessionFactory = sessionFactory.getTenantSessionFactory(tenantId)
    if (!tenantSessionFactory) {
        hibernateDatastore.mappingContext.addTenant(tenantId)
        tenantSessionFactory = sessionFactory.getTenantSessionFactory(tenantId)
        tenantSessionFactory.metadata.metadataBuilder.build()
    }

    log.info("租户[${tenantId}]添加并初始化完成...")
    return hibernateDatastore
}

2. 确保读取数据时切换租户上下文 #

读取租户数据前，必须通过TenantContext切换到目标租户，否则GORM无法识别当前租户的Schema：

// 读取目标租户数据的示例代码
String targetTenantId = "new_tenant_id"
TenantContext.withTenant(targetTenantId) {
    def contacts = Contact.list() // 在此上下文中操作目标租户的数据
}

3. 让SchemaHandler返回所有已存在的租户Schema #

部分GORM内部逻辑依赖SchemaHandler.resolveSchemaNames返回的租户列表，动态添加的租户不在其中会导致映射未加载。修改MySQLSchemaHandler，从数据库查询所有已创建的租户Schema：

class MySQLSchemaHandler extends DefaultSchemaHandler {

    MySQLSchemaHandler() {
        super("USE `%s`", "CREATE SCHEMA `%s`", "contact_app")
    }

    @Override
    Collection<String> resolveSchemaNames(DataSource dataSource) {
        def connection = dataSource.connection
        try {
            def statement = connection.createStatement()
            // 按你的租户Schema命名规则调整过滤条件，比如LIKE 'tenant_%'
            def resultSet = statement.executeQuery("SHOW SCHEMAS LIKE 'tenant%'")
            def schemas = []
            while (resultSet.next()) {
                schemas.add(resultSet.getString(1))
            }
            return schemas
        } finally {
            connection.close()
        }
    }
}

4. 同步动态Schema的元数据 #

动态创建Schema后，需同步Hibernate元数据，确保域类与表结构对应：

HibernateDatastore registerTenantDatastore(Company company) {
    String tenantId = company.tenantId
    // 确保Schema已创建
    def schemaCreator = new SchemaCreator(hibernateDatastore.mappingContext, hibernateDatastore.dataSource)
    schemaCreator.create(tenantId)
    
    hibernateDatastore.addTenantForSchema(tenantId)
    
    // 更新Schema元数据
    def sessionFactory = hibernateDatastore.sessionFactory.getTenantSessionFactory(tenantId)
    def schemaUpdate = new SchemaUpdate(sessionFactory.metadata, hibernateDatastore.dataSource)
    schemaUpdate.execute(true, true)

    log.info("租户[${tenantId}]添加并同步元数据完成...")
    return hibernateDatastore
}

1. 动态添加租户后，确认已通过TenantContext切换到目标租户ID；
2. 检查新租户Schema中是否存在contact表（与域类Contact对应）；
3. 确认调用addTenantForSchema后，已完成租户SessionFactory和域类映射的初始化。

内容的提问来源于stack exchange，提问作者fleboho