Spring data jpa中实体关系解决方案

关于Jackson双边关系无限递归、Jackson和LazyFetch的矛盾、实体类和DTO的方式的问题和解决思路

1. 出现的问题
   实体Entity之间存在多对一或者多对多关系，使用Hibernate的@OneToMany,@ManyToOne, @ManyToMany等进行标注，例：

       @Entity @Data
        @GenericGenerator(name = "jpa-uuid", strategy = "uuid")
        public class Story {
        @Id@GeneratedValue(generator = "jpa-uuid")
            String id;
            String title;
            String description;
            //忽略一些属性
        @Temporal(TemporalType.TIMESTAMP)
            Date startTime;
        @Temporal(TemporalType.TIMESTAMP)
            Date endTime;

        @ApiModelProperty("所属迭代")
        @ManyToOne(fetch = FetchType.LAZY)
        @JoinColumn(name = "iteration_id")
            Iteration iteration;

        @ApiModelProperty("包含的任务")
        @OneToMany(mappedBy = "story", fetch = FetchType.LAZY)
            List<Task> taskList = new ArrayList<>();

        @ApiModelProperty("包含的测试")
        @OneToMany(mappedBy = "story", fetch = FetchType.LAZY)
            List<TestCase> testCaseList = new ArrayList<>();
        }

直接通过Spring data jpa的Repository进行查询时，

• 会忽略LAZYFetch，查询N条语句，把所有关系的到成员全部查询一次。
• 会产生无限递归问题，因为Story中含有Task，同时Task中也包含对应的Story

2. 尝试过以下思路：
   1. 使用@JsonIgnore, @JsonPropertyIgnore, @JsonManagedReference, @JsonBackReference等对Json格式化的属性进行限制，参考Jackson双向关系
      问题在于有时候需要这些属性，比如查询同一故事下的所有任务（但是不需要他包含的测试），有时候不需要这些属性，比如查询单一故事的属性。
      同时，关系也是双向的，不存在只通过一个方向去查询（查询故事包含的任务，查询任务所属故事）
   2. 创建DTO，类似的思路还有创建接口投影或者实体视图，见Spring Data JPA和命名实体图、spring data jpa 投影。
      问题在于需要根据情况创建多个视图或者多个投影（DTO），由于各个实体间关系的复杂程度，不建议用此方式
   3. 使用@Transient注解使所有的关系不被存储，同时存在于实体中，每次使用时，自己手动查询set
      也许是一种好办法，但是失去了关系的约束，可能得不偿失
   4. 使用FetchType.LAZY的方法，在不适用关系属性时，就不会自动获取，而一旦触发使用就会自动获取其属性
      问题是Jackson对Hibernate的LazyFetch并不默认支持，需要一些额外支持
3. 最终解决方案：
   使用jackson-datatype-hibernate5插件使Jackson支持hibernate的lazyFetch，参见StackOverflow参考地址、github源码地址。配置方法如下：
   1. pom.xml中添加依赖

    <dependency>
        <groupId>com.fasterxml.jackson.datatype</groupId>
        <artifactId>jackson-datatype-hibernate5</artifactId>
        <version>2.10.1</version>
     </dependency>

2. 增加配置类

  @Configuration 
  public class HibernateModuleConfig {
         @Bean
          public MappingJackson2HttpMessageConverter mappingJackson2HttpMessageConverter() {
                MappingJackson2HttpMessageConverter jsonConverter = new MappingJackson2HttpMessageConverter();
                ObjectMapper objectMapper = jsonConverter.getObjectMapper();
                objectMapper.registerModule(new Hibernate5Module());
                return jsonConverter;
            }
        }

3. 实体上增加主键Id识别信息，防止出现循环引用
   所有关系都为Lazy，直观上不会出现循环引用，但是当你通过一对多查询而多对一存在引用时仍会出现循环引用

@JsonIdentityInfo(
      generator = ObjectIdGenerators.PropertyGenerator.class,
      property = "id")
public class CardModifyLog {}

4. 效果呈现：

   1. 默认关系属性都是null

      
      image.png

   2. 查询故事并在代码中访问taskList时，只返回想要的故事+任务，而不返回史诗、迭代等信息

        @GetMapping("story/{storyId}")
        public Story getStory(@PathVariable String storyId) {
            Story story = storyRepo.findById(storyId);
            story.getTaskList().size();
            return story;
        }

image.png