如何优雅废弃Hibernate中无用的ManyToOne关联关系？

问题背景 #

现有遗留代码中，Hibernate实体Manual包含一个嵌套的exTemplate字段，通过同表的template_id列做关联，代码定义如下：

public class Manual implements Serializable {
    @ManyToOne(fetch = FetchType.LAZY, cascade = { CascadeType.MERGE,
        CascadeType.PERSIST, CascadeType.DETACH })
    @JoinColumn(name = "template_id")
    private Manual exTemplate;
}

实际数据库中template_id字段始终为null，该关联完全无用，但EntityManager.refresh()等操作加载此关联会消耗资源。直接删除该字段风险较高，尝试添加@Transient并移除关联注解后，出现Spring启动异常：

[ERROR] org.springframework.boot.context.embedded.tomcat.TomcatStarter

• 启动Tomcat上下文失败。异常：org.springframework.beans.factory.UnsatisfiedDependencyException。
  消息：创建名为'logFilter'的Bean时出错：字段'authService'存在不满足的依赖；嵌套异常为org.springframework.beans.factory.UnsatisfiedDependencyException：
  创建名为'authService'的Bean时出错：字段'externalAuthService'存在不满足的依赖；嵌套异常为org.springframework.beans.factory.UnsatisfiedDependencyException：
  创建名为'authServiceExternalImpl'的Bean时出错：字段'mqService'存在不满足的依赖；嵌套异常为org.springframework.beans.factory.UnsatisfiedDependencyException：
  创建名为'rabbitMQService'的Bean时出错：字段'objectMapper'存在不满足的依赖；嵌套异常为org.springframework.beans.factory.BeanCreationException：
  创建类路径资源[org/springframework/data/rest/webmvc/config/RepositoryRestMvcConfiguration.class]中定义的'objectMapper' Bean时出错：
  通过工厂方法实例化Bean失败；嵌套异常为org.springframework.beans.BeanInstantiationException：
  无法实例化[com.fasterxml.jackson.databind.ObjectMapper]：工厂方法'objectMapper'抛出异常；嵌套异常为org.springframework.beans.factory.BeanCreationException：
  创建类路径资源[org/springframework/data/rest/webmvc/config/RepositoryRestMvcConfiguration.class]中定义的'config' Bean时出错：
  通过工厂方法实例化Bean失败；嵌套异常为org.springframework.beans.BeanInstantiationException：
  无法实例化[org.springframework.data.rest.core.config.RepositoryRestConfiguration]：
  工厂方法'config'抛出异常；嵌套异常为org.springframework.beans.factory.BeanCreationException：
  创建类路径资源[org/springframework/data/rest/webmvc/config/RepositoryRestMvcConfiguration.class]中定义的'repositories' Bean时出错：
  通过工厂方法实例化Bean失败；嵌套异常为org.springframework.beans.BeanInstantiationException：
  无法实例化[org.springframework.data.repository.support.Repositories]：
  工厂方法'repositories'抛出异常；嵌套异常为org.springframework.beans.factory.BeanCreationException：
  创建名为'crmTaskGoodRepository'的Bean时出错：设置Bean属性'entityManager'时无法创建类型为[org.springframework.orm.jpa.SharedEntityManagerCreator]的内部Bean'(inner bean)#787cddea'；嵌套异常为org.springframework.beans.factory.BeanCreationException：
  创建名为'(inner bean)#787cddea'的Bean时出错：设置构造函数参数时无法解析对'entityManagerFactory' Bean的引用；嵌套异常为org.springframework.beans.factory.BeanCreationException：
  创建类路径资源[org/springframework/boot/autoconfigure/orm/jpa/HibernateJpaAutoConfiguration.class]中定义的'entityManagerFactory' Bean时出错：
  调用初始化方法失败；嵌套异常为javax.persistence.PersistenceException: [PersistenceUnit: default] 无法构建Hibernate SessionFactory

解决方案 #

方案1：保留字段但禁用关联加载（低风险过渡） #

不修改关联注解，调整配置让Hibernate永远不加载这个关联，同时标记字段为废弃：

• 保留FetchType.LAZY，添加@NotFound(action = NotFoundAction.IGNORE)，当template_id为null时直接忽略关联加载
• 移除不必要的级联配置，避免无意义的级联操作
• 给getter/setter添加@Deprecated注解，提示开发者不要使用

修改后代码：

public class Manual implements Serializable {
    @ManyToOne(fetch = FetchType.LAZY)
    @JoinColumn(name = "template_id", nullable = true)
    @NotFound(action = NotFoundAction.IGNORE)
    private Manual exTemplate;
    
    @Deprecated
    public Manual getExTemplate() {
        return exTemplate;
    }
    
    @Deprecated
    public void setExTemplate(Manual exTemplate) {
        this.exTemplate = exTemplate;
    }
}

这种方式不会触发编译错误，同时消除关联加载的资源消耗，还能逐步引导团队停止使用该字段。

方案2：使用@Transient并排除Spring Data Rest影响（解决启动异常） #

之前添加@Transient启动报错，核心原因是Spring Data Rest扫描实体元数据时依赖旧关联配置导致冲突。可以按以下步骤处理：

1. 给exTemplate字段添加@Transient，移除@ManyToOne和@JoinColumn注解
2. 配置Spring Data Rest，排除该字段的暴露：

@Configuration
public class RepositoryRestConfig implements RepositoryRestConfigurer {
    @Override
    public void configureRepositoryRestConfiguration(RepositoryRestConfiguration config) {
        // 排除exTemplate字段，避免Spring Data Rest处理它
        config.getExposureConfiguration()
              .forDomainType(Manual.class)
              .withItemExposure((metadata, httpMethods) -> httpMethods.disable(HttpMethod.GET, HttpMethod.POST, HttpMethod.PUT))
              .withCollectionExposure((metadata, httpMethods) -> httpMethods.disable(HttpMethod.GET));
    }
}

如果不需要Spring Data Rest对外暴露Manual实体，也可以直接在对应的Repository接口上添加@RepositoryRestResource(exported = false)。

方案3：分阶段彻底删除 #

如果需要完全移除该关联，可分两步操作：

1. 按方案1标记废弃，同时在所有调用getExTemplate()/setExTemplate()的地方添加日志，持续观察1-2个版本周期，确认无代码依赖
2. 确认无依赖后，直接删除exTemplate字段、对应注解及getter/setter方法
3. 可选：在数据库迁移脚本中删除template_id列（不影响历史数据的前提下）

启动异常原因说明 #

从异常栈可以看出，问题出在Spring Data Rest构建RepositoryRestConfiguration时，实体元数据的变更导致初始化冲突。直接将关联字段改为@Transient后，Spring Data Rest仍尝试读取旧的关联配置，从而引发链式的Bean创建失败。通过方案2的配置排除该字段即可解决此问题。

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