Hibernate LazyInitializationException
In a Model-View-Controller pattern, the part that deals primarily with Transactions and Hibernate is the Model. This means the View, that needs the data to render the result to the user, is outside the transaction and in Hibernate this often causes LazyInitializationExceptions. Especially when traversing to proxies of collections inside the entities. In order to prevent this there are several solutions described in Open Session In View(1) article.
They are summarized below.
- use an interceptor, when the server is hit automatically start a transaction, when the result is transmitted back, automatically close/commit the transaction
- just make sure the Model provides all the data to the View, so the view does not run into the LazyInitializationException.
- have the view open a new transaction to retrieve the data, after the model is finished (which is a really really bad idea)
- have the framework deal with it
Enterprise Java Beans - The Old Way
The good part of Enterprise Java Beans is that they provide the transaction support on the container level, so you, as a developer, do not need to be concerned with it. The bad part is that to access a Enterprise Java Bean requires either another Enterprise Java Bean or a call to the InitialContext. Like in the code below.
/**
* Retrieve my gamebean.
*/
private GameBeanLocal lookupGameBeanLocal()
{
GameBeanLocal gbl = null;
try
{
javax.naming.Context c = new InitialContext();
gbl = (GameBeanLocal) c.lookup("java:global/game/game-ejb/GameBean!mmud.beans.GameBeanLocal");
} catch (NamingException ne)
{
itsLog.throwing(this.getClass().getName(), "lookupGameBeanLocal", ne);
throw new RuntimeException(ne);
}
itsLog.exiting(this.getClass().getName(), "lookupGameBeanLocal");
if (gbl == null)
{
throw new NullPointerException("unable to retrieve GameBean");
}
return gbl;
}
This is the code usually used in the WAR file of your EAR file to contact your Enterprise Java Beans. Any Hibernate entities the EJBs return suffer from the LazyInitializationException.* Retrieve my gamebean.
*/
private GameBeanLocal lookupGameBeanLocal()
{
GameBeanLocal gbl = null;
try
{
javax.naming.Context c = new InitialContext();
gbl = (GameBeanLocal) c.lookup("java:global/game/game-ejb/GameBean!mmud.beans.GameBeanLocal");
} catch (NamingException ne)
{
itsLog.throwing(this.getClass().getName(), "lookupGameBeanLocal", ne);
throw new RuntimeException(ne);
}
itsLog.exiting(this.getClass().getName(), "lookupGameBeanLocal");
if (gbl == null)
{
throw new NullPointerException("unable to retrieve GameBean");
}
return gbl;
}
Enterprise Java Beans 3.1
But now, there's Enterprise Java Beans 3.1 which solves this problem, by the following new items:
- EJBs can be contained inside your WAR
- Context and Dependency Injection works in most (more) cases
For example the following Enterprise Java Bean was put inside the WAR, and annotated with REST Annotations and uses Hibernate Entities.
/**
* Comment Enterprise Bean, maps to a Comment Hibernate Entity.
* @author mr. Bear
*/
@Stateless
@Path("/comments")
public class CommentBean
{
@PersistenceContext(unitName = "myDataSource")
private EntityManager em;
@EJB
JobBean jobBean;
protected EntityManager getEntityManager()
{
return em;
}
public CommentBean()
{
}
@POST
@Override
@Consumes(
{
"application/xml", "application/json"
})
public void create(Comment entity)
{
getEntityManager().persist(entity);
}
@PUT
@Override
@Consumes(
{
"application/xml", "application/json"
})
public void edit(Comment entity)
{
getEntityManager().merge(entity);
}
@DELETE
@Path("{id}")
public void remove(@PathParam("id") Long id)
{
getEntityManager().remove(find(id));
}
@GET
@Path("{id}")
@Produces(
{
"application/xml", "application/json"
})
public Comment find(@PathParam("id") Long id)
{
return getEntityManager().find(Comment.class, id);
}
}
* Comment Enterprise Bean, maps to a Comment Hibernate Entity.
* @author mr. Bear
*/
@Stateless
@Path("/comments")
public class CommentBean
{
@PersistenceContext(unitName = "myDataSource")
private EntityManager em;
@EJB
JobBean jobBean;
protected EntityManager getEntityManager()
{
return em;
}
public CommentBean()
{
}
@POST
@Override
@Consumes(
{
"application/xml", "application/json"
})
public void create(Comment entity)
{
getEntityManager().persist(entity);
}
@PUT
@Override
@Consumes(
{
"application/xml", "application/json"
})
public void edit(Comment entity)
{
getEntityManager().merge(entity);
}
@DELETE
@Path("{id}")
public void remove(@PathParam("id") Long id)
{
getEntityManager().remove(find(id));
}
@GET
@Path("{id}")
@Produces(
{
"application/xml", "application/json"
})
public Comment find(@PathParam("id") Long id)
{
return getEntityManager().find(Comment.class, id);
}
}
The Entity has appropriate annotations to indicate it can be converted to JSON and/or XML.
/**
* Comment Entity mapped to the Comment table in the database.
* @author mr. bear
*/
@Entity
@Table(name = "Comment")
@XmlRootElement
public class Comment implements Serializable
{
private static final long serialVersionUID = 1L;
@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
@Basic(optional = false)
@Column(name = "id")
private Long id;
@Size(max = 255)
@Column(name = "author")
private String author;
@Basic(optional = false)
@NotNull
@Column(name = "submitted")
@Temporal(TemporalType.TIMESTAMP)
private Date submitted;
@Lob
@Size(max = 65535)
@Column(name = "comment")
private String comment;
@JoinColumn(name = "galleryphotograph_id", referencedColumnName = "id")
@ManyToOne(optional = false)
private GalleryPhotograph galleryphotographId;
public Comment()
{
}
public Comment(Long id)
{
this.id = id;
}
public Comment(Long id, Date submitted)
{
this.id = id;
this.submitted = submitted;
}
public Long getId()
{
return id;
}
public void setId(Long id)
{
this.id = id;
}
public String getAuthor()
{
return author;
}
public void setAuthor(String author)
{
this.author = author;
}
public Date getSubmitted()
{
return submitted;
}
public void setSubmitted(Date submitted)
{
this.submitted = submitted;
}
public String getComment()
{
return comment;
}
public void setComment(String comment)
{
this.comment = comment;
}
@JsonIgnore
@XmlTransient
public GalleryPhotograph getGalleryphotographId()
{
return galleryphotographId;
}
public void setGalleryphotographId(GalleryPhotograph galleryphotographId)
{
this.galleryphotographId = galleryphotographId;
}
}
And, voilà, no more LazyInitializationExceptions, no more retrieving EJBs through the InitialContext, no more EARs containing WARs and EJB JARs.* Comment Entity mapped to the Comment table in the database.
* @author mr. bear
*/
@Entity
@Table(name = "Comment")
@XmlRootElement
public class Comment implements Serializable
{
private static final long serialVersionUID = 1L;
@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
@Basic(optional = false)
@Column(name = "id")
private Long id;
@Size(max = 255)
@Column(name = "author")
private String author;
@Basic(optional = false)
@NotNull
@Column(name = "submitted")
@Temporal(TemporalType.TIMESTAMP)
private Date submitted;
@Lob
@Size(max = 65535)
@Column(name = "comment")
private String comment;
@JoinColumn(name = "galleryphotograph_id", referencedColumnName = "id")
@ManyToOne(optional = false)
private GalleryPhotograph galleryphotographId;
public Comment()
{
}
public Comment(Long id)
{
this.id = id;
}
public Comment(Long id, Date submitted)
{
this.id = id;
this.submitted = submitted;
}
public Long getId()
{
return id;
}
public void setId(Long id)
{
this.id = id;
}
public String getAuthor()
{
return author;
}
public void setAuthor(String author)
{
this.author = author;
}
public Date getSubmitted()
{
return submitted;
}
public void setSubmitted(Date submitted)
{
this.submitted = submitted;
}
public String getComment()
{
return comment;
}
public void setComment(String comment)
{
this.comment = comment;
}
@JsonIgnore
@XmlTransient
public GalleryPhotograph getGalleryphotographId()
{
return galleryphotographId;
}
public void setGalleryphotographId(GalleryPhotograph galleryphotographId)
{
this.galleryphotographId = galleryphotographId;
}
}
Infinite Recursion
One of the problems that occur, when you do NOT have any LazyInitializationExceptions, is Infinite Recursion. This happens when your Hibernate entities refer to each other, and in a REST service, Jersey tries to flatten the structure into JSON or XML for transmission.
This could be the case, in the example above, if there was a collection of comments in galleryphotograph, and a reference to the respective galleryphotograph in the comments.
In order to solve this, make sure to use XmlTransient and JsonIgnore at appropriate places.
Conclusion
The last paragraph "Can't this be done easier" in the Open Session In View is awesome. It provides the answer that the framework should handle all the transaction management, instead of yourself having to provide it.
And now this time has come! The new EJB 3.1 version allows you to put EJBs right there in your WAR! Either as a separate JAR file, or as class files. The same classloader will pick them up and you can use them in your classes via Dependency Injection as much as you like!
It does mean there is no modularization, but in my experience modularization is only a requirement for the exceptionally high-end big projects.
References
- Open Session In View
- https://community.jboss.org/wiki/OpenSessionInView
- Data Transfer Objects
- http://martinfowler.com/eaaCatalog/dataTransferObject.html
- Wikipedia : Data Transfer Object
- http://en.wikipedia.org/wiki/Data_transfer_object
- Java Persistence With Hibernate
- Christian Bauer, Gavin King
- Is Java EE 6 War The New EAR? The Pragmatic Modularization And Packaging
- http://www.adam-bien.com/roller/abien/entry/is_java_ee_6_war
