Attribute Lazy Loading And Jackson Serialization
Description: By default, the attributes of an entity are loaded eagerly (all at once). But, we can load them lazy as well. This is useful for column types that store large amounts of data: CLOB, BLOB, VARBINARY, etc or details that should be loaded on demand. In this application, we have an entity named Author. Its properties are: id, name, genre, avatar and age. And, we want to load the avatar lazy. But, returning entities (as JSON) that contains un-fetched lazy attributes from a REST controller (@RestController) will cause lazy initialization exceptions because Jackson tries to force the fetching of these attributes outside a Hibernate session.
Key points:
- for Maven, in
pom.xml, activate Hibernate bytecode enhancement (e.g. use Maven bytecode enhancement plugin) - in entity, annotate the attributes that should be loaded lazy with
@Basic(fetch = FetchType.LAZY) - in
application.properties, disable Open Session in View - annotate the
Authorentity with@JsonFilter("AuthorId") - create and configure the
AuthorIdfilter to be used by default viaSimpleBeanPropertyFilter.serializeAll() - at controller level (in the needed endpoint) override the
AuthorIdfilter with one asSimpleBeanPropertyFilter.filterOutAllExcept("id", "name", "age", "genre")and returnMappingJacksonValue - a controller endpoint that need to use the overriden version of
AuthorIdfilter should rely onMappingJacksonValue
Run the following requests (via BookstoreController):
- lazy fetch the avatar of an author by id:
localhost:8080/author/avatar/{id} - fetch authors by age greater than or equal to the given age without avatar:
localhost:8080/authors/{age} - fetch authors by age greater than or equal to the given age with and avatar (but, don't do this, notice the N+1 issue caused by looping the list of authors and triggering SQLs for fetching the avatar of each author):
localhost:8080/authors/details/{age}
Check as well:
