Hibernate Tips: How to use Hibernate’s native bootstrapping API

By Thorben Janssen

Configuration

Hibernate Tips is a series of posts in which I describe a quick and easy solution for common Hibernate questions. If you have a question you like me to answer, please leave a comment below.

Question:

I need more control over Hibernate’s internal configuration. How can I use its native bootstrapping API?

Solution:

Hibernate’s native bootstrapping API is very flexible which makes it more complicated to use but also more powerful than the JPA bootstrapping API. I, therefore, recommend using the JPA API, if you don’t need this flexibility.

Before you can start the bootstrapping process, you need to add the required dependencies to your classpath. I’m using Hibernate 5.2.8.Final for the examples of this book and the hibernate-core.jar file is the only required Hibernate dependency.
It also includes the JPA jar-file as a transitive dependency.

You also need to add a database-specific JDBC driver to the classpath of your application. Please check your database documentation for more information.

As soon as you’ve added the required dependencies, you can implement the bootstrapping process. You need to create a StandardServiceRegistry, build a Metadata object and use it to instantiate a SessionFactory.

Hibernate uses two service registries, the BootstrapServiceRegistry and the StandardServiceRegistry. The default BootstrapServiceRegistry provides a good solution for most applications and I, therefore, skip the programmatic definition of it in this example.

But you need to configure the StandardServiceRegistry. I do that in this example with a hibernate.cfg.xml file. It makes the implementation easy and allows you to change the configuration without changing the source code. Hibernate loads the configuration file automatically from the classpath when you call the configure method on the StandardServiceRegistryBuilder. You can then adapt the configuration programmatically before you call the build method to get a ServiceRegistry.

The following code snippet shows an example of a hibernate.cfg.xml configuration file. It tells Hibernate to use the PostgreSQLDialect and to connect to a PostgreSQL database on localhost. It also tells Hibernate to generate the database tables based on the entity mappings. Your configuration might differ if you use a different database or a connection pool.

WARNING: Generating your database tables based on entity mappings is not recommended for production!

After you instantiated a configured ServiceRegistry, you need to create a Metadatarepresentation of your domain model.
You can do that based on the configuration files hbm.xml and orm.xml or annotated entity classes. I use annotated classes in the following code snippet.
I first use the ServiceRegistry which I created in the previous step to instantiate a new MetadataSources object. Then I add my annotated entity classes and call the buildMetadata to create the Metadata representation. In this example, I use only the Author entity. After that is done, I call the buildSessionFactory method on the Metadata object to instantiate a SessionFactory.

That is all you need to do to create a basic Hibernate setup with its native API. You can now use the SessionFactory to open a new Session and use it to read or persist entities.


 

Hibernate Tips Book







Get more recipes like this one in my new book Hibernate Tips: More than 70 solutions to common Hibernate problems.

It gives you more than 70 ready-to-use recipes for topics like basic and advanced mappings, logging, Java 8 support, caching, and statically and dynamically defined queries.

Get it now!



Tags

Configuration


About the author

Thorben is an independent consultant, international speaker, and trainer specialized in solving Java persistence problems with JPA and Hibernate.
He is also the author of Amazon’s bestselling book Hibernate Tips - More than 70 solutions to common Hibernate problems.

Books and Courses

Coaching and Consulting

Leave a Reply

Your email address will not be published. Required fields are marked

This site uses Akismet to reduce spam. Learn how your comment data is processed.

{"email":"Email address invalid","url":"Website address invalid","required":"Required field missing"}