98

When i try to navigate to an endpoint i get the following error

Type definition error: [simple type, class org.hibernate.proxy.pojo.bytebuddy.ByteBuddyInterceptor]; nested exception is com.fasterxml.jackson.databind.exc.InvalidDefinitionException: No serializer found for class org.hibernate.proxy.pojo.bytebuddy.ByteBuddyInterceptor and no properties discovered to create BeanSerializer (to avoid exception, disable SerializationFeature.FAIL_ON_EMPTY_BEANS)

I checked all my models and all the attributes have getters and setters. So what's the problem ?

I can fix that by adding spring.jackson.serialization.fail-on-empty-beans=false but i think this is just a work around to hide the exception.

Edit

Product model:

@Entity
public class Product {
    private int id;
    private String name;
    private String photo;
    private double price;
    private int quantity;
    private Double rating;
    private Provider provider;
    private String description;
    private List<Category> categories = new ArrayList<>();
    private List<Photo> photos = new ArrayList<>();
    
    // Getters & Setters
}

PagedResponse class :

public class PagedResponse<T> {

    private List<T> content;
    private int page;
    private int size;
    private long totalElements;
    private int totalPages;
    private boolean last;
    
    // Getters & Setters
}

RestResponse Class :

public class RestResponse<T> {
    private String status;
    private int code;
    private String message;
    private T result;

    // Getters & Setters
}

In my controller i'm returning ResponseEntity<RestResponse<PagedResponse<Product>>>

Ayoub k
  • 6,446
  • 6
  • 29
  • 49
  • I faced the same exact issue, added the prop entry and I'm able to see the response, previously it was failing. Thanks for this questions and the hint `fail-on-empty-beans` – Anand Rockzz Nov 12 '18 at 02:08
  • 1
    check the answer here https://stackoverflow.com/a/51129161/2160969 – Wiz May 14 '19 at 05:55

12 Answers12

170

I came across this error while doing a tutorial with spring repository. It turned out that the error was made at the stage of building the service class for my entity.

In your serviceImpl class, you probably have something like:

    @Override
    public YourEntityClass findYourEntityClassById(Long id) {
      return YourEntityClassRepositorie.getOne(id);
    }

Change this to:

    @Override
    public YourEntityClass findYourEntityClassById(Long id) {
      return YourEntityClassRepositorie.findById(id).get();
    }

Basically getOne is a lazy load operation. Thus you get only a reference (a proxy) to the entity. That means no DB access is actually made. Only when you call it's properties then it will query the DB. findByID does the call 'eagerly'/immediately when you call it, thus you have the actual entity fully populated.

Take a look at this: Link to the difference between getOne & findByID

Chandrahas Aroori
  • 877
  • 2
  • 13
  • 26
Szelek
  • 2,149
  • 4
  • 13
  • 19
  • Thank you for sharing. – seenimurugan Mar 09 '20 at 19:47
  • @Szelek thanks for this, i was getting the same error cause i was using getOne() method now changed it to findById(id).get(). – Rajan Chauhan May 15 '20 at 12:28
  • wow, @Szelek, You are god. I don't understand why this little change saved my life. – Lay Leangsros May 24 '20 at 12:41
  • Fixed for me, thanks for the info. Watched a tutorial where they used getOne(), anyone know why that method is not working properly? – Martin Boros May 29 '20 at 17:46
  • 4
    @LayLeangsros wondered the same thing my self. Found this great article which describes the differences between the getOne and findById. Basically getOne is a lazy load operation. Thus you get only a reference (a proxy) to the entity. That means no DB access is actually made. Only when you call it's properties then it will query the DB. findByID does the call eagry right when you call it, thus you have the actual entity fully populated. https://www.javacodemonk.com/difference-between-getone-and-findbyid-in-spring-data-jpa-3a96c3ff – Gorjan Mishevski Sep 27 '20 at 13:07
  • Any future people to run into this problem remember there are two methods findById and getById. findById returns an optional that's why you have to do a .get at the end of the method call. Change it to findById and you will be fine. – AmohPrince Apr 27 '22 at 07:17
112

You can Ignore to produce JSON output of a property by

@JsonIgnore 

Or If you have any lazy loaded properties having a relationship. You can use this annotation at top of the property.

@JsonIgnoreProperties({"hibernateLazyInitializer", "handler"}) 

Example:

@Entity
public class Product implements Serializable{
   private int id;
   private String name;
   private String photo;
   private double price;
   private int quantity;
   private Double rating;
   private Provider provider;
   private String description;

   @JsonIgnoreProperties({"hibernateLazyInitializer", "handler"})
   private List<Category> categories = new ArrayList<>();

   @JsonIgnoreProperties({"hibernateLazyInitializer", "handler"})
   private List<Photo> photos = new ArrayList<>();

   // Getters & Setters
}

If you still have this error, please add this line of code in your application.properties file

spring.jackson.serialization.fail-on-empty-beans=false

I hope your problem will be solved. Thanks.

Subarata Talukder
  • 4,247
  • 1
  • 28
  • 36
  • 2
    The solution provided with "@JsonIgnoreProperties" did not work for me. Changing from FetchType.LAZY to FetchType.EAGER fixed the issue. – ghjansen May 14 '19 at 00:49
  • @Subarata Talukder - If we use `@JsonIgnore`, then we loose the entity graph details as well.. – PAA Aug 06 '19 at 06:12
  • @ghjansen - I'm also getting same error, but in my case, I can't keep doing `FetchType.EAGER`. Could you please help me with this ? – PAA Aug 06 '19 at 13:14
  • I'd wonder why anyone would use Serializable interface anymore. Is that a Hibernate requirement? – duffymo Aug 06 '19 at 18:14
  • @PAA sorry for the delay. Not sure if still in time, but I suggest you to take a look at https://www.baeldung.com/hibernate-lazy-eager-loading to double check if you are using lazy loading the right way. As explained in "5. Differences", I guess that in my case the exception occurred due to missing call of getter, which triggers the fetch, initializing all attributes of a given object. Alternative to that, there is a way to use a proxy, also explained in this same post. I will soon leave eager and go back to lazy, as eager is a bad practice. – ghjansen Sep 25 '19 at 12:16
  • Please add this line in your application.properties file spring.jackson.serialization.fail-on-empty-beans=false, if you have still this issue. – Subarata Talukder Sep 26 '19 at 03:35
  • 1
    spring.jackson.serialization.fail-on-empty-beans=false, worked for me Thanks :) – Noorus Khan Aug 24 '20 at 09:08
  • But this is not an answer to the question – ACV Sep 05 '20 at 10:46
  • Pls let the answer of the question @ACV. – Subarata Talukder Sep 06 '20 at 17:36
  • Adding spring.jackson.serialization.fail-on-empty-beans=false in my properties file solved it for me – Edor Linus Jun 08 '21 at 03:23
13

Changing the FetchType from lazy to eager did the trick for me.

Chris Neve
  • 1,838
  • 18
  • 27
7

@JsonIgnoreProperties({"hibernateLazyInitializer", "handler"}) work for me very well. It doesn't miss any reference objects and resolve the problem.

In my case:

@Entity
@Table(name = "applications")
public class Application implements Serializable {

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

    @NotBlank
    @Size(max = 36, min = 36)
    private String guid;

    @NotBlank
    @Size(max = 60)
    private String name;

    @Column(name = "refresh_delay")
    private int refreshDelay;

    @ManyToOne(fetch = LAZY)
    @JoinColumn(name = "id_production", referencedColumnName = "id")
    @JsonIgnoreProperties(value = {"applications", "hibernateLazyInitializer"})
    private Production production;
Seldo97
  • 513
  • 1
  • 4
  • 13
5

This solved my issue.

 @JsonIgnoreProperties({"hibernateLazyInitializer", "handler"})
Ahmad Karimi
  • 1,239
  • 2
  • 14
  • 24
Arber Berisha
  • 51
  • 1
  • 3
3

i also faced same problem. I was using repo.getOne(id); i changed it to repo.findById(id). It returned optional, but now error is gone

akhil
  • 66
  • 4
2

I also faced with this problem. @Szelek's answer helped me. But I did it with another way. Changed getOne() method to:

repository.findById(id).orElse(null)

Ensure you are taking care of the NullPointerException this will generate when it's not found.

Chandrahas Aroori
  • 877
  • 2
  • 13
  • 26
SNabi
  • 69
  • 1
  • 5
2

This answer comes from the book: "learn microservices with spring boot" Instead of supressing the error on empty bean which is suggested by the spring there are more preferable ways to handle this.

We configured our nested User entities to be fetched in LAZY mode, so they’re not being queried from the database. We also said that Hibernate creates proxies for our classes in runtime. That’s the reason behind the ByteBuddyInterceptor class. You can try switching the fetch mode to EAGER, and you will no longer get this error. But that’s not the proper solution to this problem since then we’ll be triggering many queries for data we don’t need. Let’s keep the lazy fetch mode and fix this accordingly. The first option we have is to customize our JSON serialization so it can handle Hibernate objects. Luckily, FasterXML,the provider of Jackson libraries, has a specific module for Hibernate that we can use in our ObjectMapper objects: jackson-datatype-hibernate:

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

We create a bean for our new Hibernate module for Jackson. Spring Boot’s Jackson2ObjectMapperBuilder will use it via autoconfiguration, and all our ObjectMapper instances will use the Spring Boot defaults plus our own customization.

import com.fasterxml.jackson.databind.Module;
import com.fasterxml.jackson.datatype.hibernate5.Hibernate5Module;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
public class JsonConfiguration {
    @Bean
    public Module hibernateModule() {
        return new Hibernate5Module();
    }
}
kvs
  • 59
  • 8
1

Changing from

MyEntityClassRepositorie.getOne(id)

to

MyEntityClassRepositorie.findById(id).get()

work fine for me.

Sergi
  • 135
  • 7
0

Hmm are you traying to send entities from one instance of the jvm to another one which need to serialize them? if this is the case i think the error is because you fetched the entities somehow and hibernate is using its not serializable classes, you need to convert entities to pojo's (i mean use native types or objects that are serializables).

Ivan Perales M.
  • 337
  • 3
  • 11
  • I don't understand exactly what you're saying but I think I'm doing that, please check my edit. – Ayoub k Oct 05 '18 at 12:17
0

For me, I got this error for a DTO object. The problem was I didn't provide getters for DTO properties. Therefore, Jackson was not able to fetch those values and assumed the bean is empty. Solution:

Add Getters to your DTO

Meena Chaudhary
  • 8,537
  • 12
  • 49
  • 81
0

In my case I was facing same exception with @EntityGraph. Actually I was trying to featch OneToMany (inventoryList) via EntityGraph and it's working but when I tried get another relation with ManyToOne (category) it's giving error. I don't know why it become lazzy. As we know @ManyToOne by default Eager.

class Product {
 
    @ManyToOne
    @JoinColumn(name = "categoryId")
    private Category category;

    @OneToMany(mappedBy = "product", cascade = CascadeType.ALL)
    private List<Inventory> inventoryList;
}

Repository method:

@EntityGraph(attributePaths = { "inventoryList" })
List<Product> findAll();

I was getting same expection because I didn't add category in EntityGraph fetch. After adding category it's get fixed.

@EntityGraph(attributePaths = { "inventoryList", "category" })
List<Product> findAll();
Az.MaYo
  • 983
  • 9
  • 23