Spring Boot JPA Entity Jackson序列化触发懒加载的解决方案

weknow619 发布于2019-08-16 15:32 / 2694人阅读

摘要：究其原因就是没有办法被序列化，网上有很多的方法，例如，这是治标不治本的方法现在要达到的目标是当有关联数据的时候序列化，不存在的时候不返回，或者直接返回。到这里我们就可以达到预期的目的了。

Spring Jpa这项技术在Spring 开发中经常用到。

今天在做项目用到了Entity的关联懒加载，但是在返回Json的时候，不管关联数据有没有被加载，都会触发数据序列化，而如果关联关系没有被加载，此时是一个HibernateProxy，并不是真实的数据，而导致了报错。

例如这个Topic Entity:

@Entity
@Table(name = "yms_topics")
@Getter
@Setter
@NoArgsConstructor
@EntityListeners(AuditingEntityListener.class)
@JsonInclude(JsonInclude.Include.NON_EMPTY)
@NamedEntityGraphs({
        @NamedEntityGraph(name = "topic.all",
                attributeNodes = {
                        @NamedAttributeNode(value = "author"),
                        @NamedAttributeNode(value = "category")
                })
})
public class Topic implements Serializable {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    @ManyToOne(targetEntity = User.class, cascade = CascadeType.ALL, fetch = FetchType.LAZY)
    @JoinColumn(name = "user_id")
    private User author;

    @ManyToOne(targetEntity = TopicCategory.class, cascade = CascadeType.ALL, fetch = FetchType.LAZY)
    @JoinColumn(name = "category_id")
    private TopicCategory category;

    @Column(nullable = false, length = 200)
    private String title;

    @Lob
    @Column(nullable = false, length = 50000)
    private String content;

    @CreatedDate
    private Date createdAt;

    @LastModifiedDate
    private Date updatedAt;
}

author 和 category 都是多对一的关联，也就是作者和分类，定义的是懒加载LAZY，现在需要分页取出记录，Repository 如下：

@EntityGraph(value = "topic.all")
Page findAll(Pageable pageable);

这是关联读取author和category数据，没有任何问题。但是如果有的关联不需要加载，将EntityGraph去掉，就会报错。

Page findAll(Pageable pageable);

究其原因就是HibernateProxy 没有办法被序列化，网上有很多的方法，例如JsonIgnoreProperties，这是治标不治本的方法

现在要达到的目标是当有关联数据的时候序列化，不存在的时候不返回，或者直接返回Null。

其实要解决这个问题很简单，那就是使用 Jackson 的一个包 jackson-datatype-hibernate5。
首先gradle添加依赖：

compile group: "com.fasterxml.jackson.datatype", name: "jackson-datatype-hibernate5", version: "2.9.8"

这个版本要注意jackson-datatype-hibernateX，根据Hibernate的版本来定

然后我们要重写 SpringMvc的 MappingJackson2HttpMessageConverter，将Hibernate5Module这个Module 注册到ObjectMapper。

我们新建一个WebMvcConfig类，如下：

@Configuration
public class WebMvcConfig {

    @Bean
    public MappingJackson2HttpMessageConverter mappingJackson2HttpMessageConverter() {
        MappingJackson2HttpMessageConverter converter = new MappingJackson2HttpMessageConverter();
        ObjectMapper mapper = converter.getObjectMapper();
        Hibernate5Module hibernate5Module = new Hibernate5Module();
        mapper.registerModule(hibernate5Module);
        mapper.setDateFormat(new SimpleDateFormat("yyyy-MM-dd HH:mm:ss"));
        return converter;
    }
}

这是一个Config类,很简单

就是注入一个Bean，类型为MappingJackson2HttpMessageConverter，获取到ObjectMapper

通过mapper.registerModule(hibernate5Module);注册Module

还可以定义时间如期的序列化格式。

注意如果要让未加载的时候完全不输出，那么在Entity的类级别注解要使用Empty，例如：@JsonInclude(JsonInclude.Include.NON_EMPTY)，不然当数据为null的时候会输出null。

到这里我们就可以达到预期的目的了。

这里可能会导致spring.jackson的配置失效，以后再行研究。

服务器托管私有云 json序列化懒加载 Spring Boot spring data jpa js实现数据的懒加载图片

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/73540.html

Spring Boot QuickStart (5) - Spring Data JPA

摘要：关联关系的关联关系定义上，感觉并不是很灵活，姿势也比较难找。如，定义在关联关系上的参数可以设置级联的相关东西。因为序列化会涉及到实体类关联对象的获取，会触发所有的关联关系。接(4) - Database 系列. Java Persistence API，可以理解就是 Java 一个持久化标准或规范，Spring Data JPA 是对它的实现。并且提供多个 JPA 厂商适配，如 Hi...

sutaking 2019-08-15 10:39 评论0 收藏0
记一次Spring Batch完整入门实践

摘要：什么是作为的子项目，是一款基于的企业批处理框架。首先，运行的基本单位是一个，一个就做一件批处理的事情。总结为我们提供了非常实用的功能，对批处理场景进行了完善的抽象，它不仅能实现小数据的迁移，也能应对大企业的大数据实践应用。前言本文将从0到1讲解一个Spring Batch是如何搭建并运行起来的。本教程将讲解从一个文本文件读取数据，然后写入MySQL。什么是 Spring Batc...

Baaaan 2019-08-19 11:06 评论0 收藏0
【从零入门系列-2】Spring Boot 之数据库实体定义实现

摘要：文章系列从零入门系列之从零入门系列之程序结构设计说明前言本篇文章开始代码实践，系统设计从底向上展开，因此本篇先介绍如何实现数据库表实体类的设计实现。主键由数据库自动生成主要是自动增长型主键由程序控制。文章系列【从零入门系列-0】Sprint Boot 之 Hello World 【从零入门系列-1】Sprint Boot 之程序结构设计说明前言本篇文章开始代码实践，系统...

nemo 2019-08-19 11:41 评论0 收藏0
Lombok安装及Spring Boot集成Lombok

摘要：注意，其是在编译源码过程中，帮你自动生成的。就是说，将极大减少你的代码总量。注解和类似，区别在于它会把所有成员变量默认定义为修饰，并且不会生成方法。不同的日志注解总结如下上面是注解，下面是编译后的代码参考资料下的安装以及使用简介注解介绍 Lombok有什么用在我们实体Bean中有大量的Getter/Setter方法以及toString, hashCode等可能不会用到，但是某些时候仍...

dkzwm 2019-08-16 15:49 评论0 收藏0
一起来学SpringBoot | 第六篇：整合SpringDataJpa

摘要：忽略该字段的映射省略创建数据访问层接口，需要继承，第一个泛型参数是实体对象的名称，第二个是主键类型。 SpringBoot 是为了简化 Spring 应用的创建、运行、调试、部署等一系列问题而诞生的产物，自动装配的特性让我们可以更好的关注业务本身而不是外部的XML配置，我们只需遵循规范，引入相关的依赖就可以轻易的搭建出一个 WEB 工程上一篇介绍了Spring JdbcTempl...

Dionysus_go 2019-08-16 12:35 评论0 收藏0