Hibernate & Spring Boot Samples
Description: This application is a sample of how to store date, time, and timestamps in UTC time zone in MySQL.
Key points:
- spring.jpa.properties.hibernate.jdbc.time_zone=UTC
- spring.datasource.url=jdbc:mysql://localhost:3306/screenshotdb?useLegacyDatetimeCode=false
Description: View the prepared statement binding/extracted parameters via Log4J 2 logger setting.
Key points:
- for Maven, in pom.xml
, exclude Spring Boot's Default Logging
- for Maven, in pom.xml
, Add Log4j 2 Dependency
- in log4j2.xml
add, <Logger name="org.hibernate.type.descriptor.sql" level="trace"/>
Description: View the query details (query type, binding parameters, batch size, execution time, etc) via datasource-proxy
Key points:
- for Maven, add in pom.xml
the datasource-proxy
dependency
- create an bean post processor to intercept the DataSource
bean
- wrap the DataSource
bean via ProxyFactory
and an implementation of MethodInterceptor
Description: Batch inserts via SimpleJpaRepository#saveAll(Iterable<S> entities)
method in MySQL
Key points:
- in application.properties
set spring.jpa.properties.hibernate.jdbc.batch_size
- in application.properties
set spring.jpa.properties.hibernate.generate_statistics
(just to check that batching is working)
- in application.properties
set JDBC URL with rewriteBatchedStatements=true
(optimization for MySQL)
- in application.properties
set JDBC URL with cachePrepStmts=true
(enable caching and is useful if you decide to set prepStmtCacheSize
, prepStmtCacheSqlLimit
, etc as well; without this setting the cache is disabled)
- in application.properties
set JDBC URL with useServerPrepStmts=true
(this way you switch to server-side prepared statements (may lead to signnificant performance boost))
- in case of using a parent-child relationship with cascade persist (e.g. one-to-many, many-to-many) then consider to set up spring.jpa.properties.hibernate.order_inserts=true
to optimize the batching by ordering inserts
- in entity, use the assigned generator since MySQL IDENTITY
will cause batching to be disabled
- in entity, add @Version
property to avoid extra-SELECT
s fired before batching (also prevent lost updates in multi-request transactions). Extra-SELECT
s are the effect of using merge()
instead of persist()
; behind the scene, saveAll()
uses save()
, which in case of non-new entities (have IDs) will call merge()
, which instruct Hibernate to fire a SELECT
statement to make sure that there is no record in the database having the same identifier
- pay attention on the amount of inserts passed to saveAll()
to not "overwhelm" the persistence context; normally the EntityManager
should be flushed and cleared from time to time, but during the saveAll()
execution you simply cannot do that, so if in saveAll()
there is a list with a high amount of data, all that data will hit the persistence context (1st level cache) and will be in-memory until flush time. Using relatively small amount of data should be ok
Description: Batch inserts via EntityManager
in MySQL. This way you can easily control the flush()
and clear()
of the persistence context (1st level cache). This is not possible via SpringBoot, saveAll(Iterable<S> entities)
. Another advantage is that you can call persist()
instead of merge()
- this is used behind the scene by the SpringBoot saveAll(Iterable<S> entities)
and save(S entity)
.
Key points:
- in application.properties
set spring.jpa.properties.hibernate.jdbc.batch_size
- in application.properties
set spring.jpa.properties.hibernate.generate_statistics
(just to check that batching is working)
- in application.properties
set JDBC URL with rewriteBatchedStatements=true
(optimization for MySQL)
- in application.properties
set JDBC URL with cachePrepStmts=true
(enable caching and is useful if you decide to set prepStmtCacheSize
, prepStmtCacheSqlLimit
, etc as well; without this setting the cache is disabled)
- in application.properties
set JDBC URL with useServerPrepStmts=true
(this way you switch to server-side prepared statements (may lead to signnificant performance boost))
- in case of using a parent-child relationship with cascade persist (e.g. one-to-many, many-to-many) then consider to set up spring.jpa.properties.hibernate.order_inserts=true
to optimize the batching by ordering inserts
- in entity, use the assigned generator since MySQL IDENTITY
will cause batching to be disabled
- in DAO, flush and clear the persistence context from time to time; this way you avoid to "overwhelm" the persistence context
- if is not needed then ensure that Second Level Cache is disabled via spring.jpa.properties.hibernate.cache.use_second_level_cache=false
Description: Batch inserts via JpaContext/EntityManager
in MySQL.
Key points:
- in application.properties
set spring.jpa.properties.hibernate.jdbc.batch_size
- in application.properties
set spring.jpa.properties.hibernate.generate_statistics
(just to check that batching is working)
- in application.properties
set JDBC URL with rewriteBatchedStatements=true
(optimization for MySQL)
- in application.properties
set JDBC URL with cachePrepStmts=true
(enable caching and is useful if you decide to set prepStmtCacheSize
, prepStmtCacheSqlLimit
, etc as well; without this setting the cache is disabled)
- in application.properties
set JDBC URL with useServerPrepStmts=true
(this way you switch to server-side prepared statements (may lead to signnificant performance boost))
- in case of using a parent-child relationship with cascade persist (e.g. one-to-many, many-to-many) then consider to set up spring.jpa.properties.hibernate.order_inserts=true
to optimize the batching by ordering inserts
- in entity, use the assigned generator since MySQL IDENTITY
will cause batching to be disabled
- the EntityManager
is obtain per entity type via, JpaContext#getEntityManagerByManagedType(Class<?> entity)
- in DAO, flush and clear the persistence context from time to time; this way you avoid to "overwhelm" the persistence context
Description: Batch inserts via Hibernate session-level batching (Hibernate 5.2 or higher) in MySQL.
Key points:
- in application.properties
set spring.jpa.properties.hibernate.generate_statistics
(just to check that batching is working)
- in application.properties
set JDBC URL with rewriteBatchedStatements=true
(optimization for MySQL)
- in application.properties
set JDBC URL with cachePrepStmts=true
(enable caching and is useful if you decide to set prepStmtCacheSize
, prepStmtCacheSqlLimit
, etc as well; without this setting the cache is disabled)
- in application.properties
set JDBC URL with useServerPrepStmts=true
(this way you switch to server-side prepared statements (may lead to signnificant performance boost))
- in case of using a parent-child relationship with cascade persist (e.g. one-to-many, many-to-many) then consider to set up spring.jpa.properties.hibernate.order_inserts=true
to optimize the batching by ordering inserts
- in entity, use the assigned generator since MySQL IDENTITY
will cause batching to be disabled
- the Hibernate Session
is obtained by un-wrapping it via EntityManager#unwrap(Session.class)
- the batching size is set via Session#setJdbcBatchSize(Integer size)
and get via Session#getJdbcBatchSize()
- in DAO, flush and clear the persistence context from time to time; this way you avoid to "overwhelm" the persistence context
Description: Direct fetching via Spring Data, EntityManager
and Hibernate Session
examples.
Key points:
- direct fetching via Spring Data uses findById()
- direct fetching via EntityManager
uses find()
- direct fetching via Hibernate Session
uses get()
Note: You may also like to read the recipe, "How To Enrich DTOs With Virtual Properties Via Spring Projections"
Description: Fetch only the needed data from the database via Spring Data Projections (DTOs)
Key points:
- write an interface (projection) containing getters only for the columns that should be fetched from the database
- write the proper query returning a List<projection>
- if is applicable, limit the number of returned rows (e.g., via LIMIT
) - here, we can use query builder mechanism built into Spring Data repository infrastructure
Note: Using projections is not limited to use query builder mechanism built into Spring Data repository infrastructure. We can fetch projections via JPQL or native queries as well. For example, in this application we use a JPQL.
Output example (select first 2 rows; select only "name" and "age"):
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. So, the avatar
should be loaded on demand.
Key points:
- in pom.xml
, activate Hibernate bytecode instrumentation (e.g. use Maven bytecode enhancement plugin)
- in entity, annotate the columns that should be loaded lazy with @Basic(fetch = FetchType.LAZY)
- in application.properties
, disable Open Session in View
Check as well:
- Default Values For Lazy Loaded Attributes
- Attribute Lazy Loading And Jackson Serialization
Description: A Proxy
can be useful when a child entity can be persisted with a reference to its parent. In such cases, fetching the parent entity from the database (execute the SELECT
statement) is a performance penalty and a pointless action. Hibernate can set the underlying foreign key value for an uninitialized Proxy
.
Key points:
- rely on EntityManager#getReference()
- in Spring, use JpaRepository#getOne()
-> used in this example
- in Hibernate, use load()
- here, we have two entities, Tournament
and TennisPlayer
, and a tournament can have multiple players (@OneToMany
)
- we fetch the tournament via a Proxy
(this will not trigger a SELECT
), we create a new tennis player, we set the Proxy
as the tournament for this player and we save the player (this will trigger an INSERT
in the tennis players table, tennis_player
)
Output example:
- the console output will reveal that only an INSERT
is triggered, not the SELECT
Description: N+1 is an issue of lazy fetching (but, eager is not exempt). This application reproduce the N+1 behavior.
Key points:
- define two entities, Category
and Product
having a @OneToMany
relationship
- fetch all Product
lazy, so without Category
(results in 1 query)
- loop the fetched Product
collection and for each entry fetch the corresponding Category
(results N queries)
Description: Starting with Hibernate 5.2.2, we can optimize SELECT DISTINCT
via HINT_PASS_DISTINCT_THROUGH
hint
Key points:
- use @QueryHints(value = @QueryHint(name = HINT_PASS_DISTINCT_THROUGH, value = "false"))
Description: Prior to Hibernate version 5, the dirty checking mechanism relies on Java Reflection API. Starting with Hibernate version 5, the dirty checking mechanism relies on bytecode enhancement. This approach sustain a better performance, especially when you have a relatively large number of entitites.
Key points:
- add the corresponding plugin
in pom.xml (use Maven bytecode enhancement plugin)
The bytecode enhancement effect can be seen on User.class
here
Description: This application is an example of how is correct to use the Java 8 Optional
in entities and queries.
Key points:
- use the Spring Data built-in query-methods that return Optional
(e.g., findById()
)
- write your own queries that return Optional
- use Optional
in entities getters
- in order to run different scenarios check the file, data-mysql.sql
Description: This application is a proof of concept of how is correct to implement the bidirectional @OneToMany
association.
Key points:
- always cascade from parent to child
- use mappedBy
on the parent
- use orphanRemoval
on parent in order to remove children without references
- use helper methods on parent to keep both sides of the association in sync
- use lazy fetching on both side of the association
- as entities identifiers, use assigned identifiers (business key, natural key (@NaturalId
)) and/or database-generated identifiers and override (on child-side) properly the equals()
and hashCode()
methods as here
- if toString()
need to be overridden, then pay attention to involve only for the basic attributes fetched when the entity is loaded from the database
Description: This application is a proof of concept of how to write a query via JpaRepository
, EntityManager
and Session
.
Key points:
- for JpaRepository
use @Query
or Spring Data Query Creation
- for EntityManager
and Session
use the createQuery()
method
Description: In MySQL & Hibernate 5, the GenerationType.AUTO
generator type will result in using the TABLE
generator. This adds a significant performance penalty. Turning this behavior to IDENTITY
generator can be obtained by using GenerationType.IDENTITY
or the native generator.
Key points:
- use GenerationType.IDENTITY
instead of GenerationType.AUTO
- use the native generator - exemplified in this application
Description: This application is an example when calling save()
for a managed entity is redundant.
Key points:
- Hibernate triggers UPDATE
statements for managed entities without the need to explicitly call the save()
method
- behind the scene, this redundancy implies a performance penalty as well
Description: In PostgreSQL, using GenerationType.IDENTITY
will disable insert batching. The (BIG)SERIAL
is acting "almost" like MySQL, AUTO_INCREMENT
. In this application, we use the GenerationType.SEQUENCE
which enable insert batching, and we optimize it via the hi/lo
optimization algorithm.
Key points:
- use GenerationType.SEQUENCE
instead of GenerationType.IDENTITY
- rely on the hi/lo
algorithm to fetch multiple identifiers in a single database roundtrip (you can go even further and use the Hibernate pooled
and pooled-lo
identifier generators (these are optimizations of hi/lo
))
Description: This application is a sample of JPA Single Table inheritance strategy (SINGLE_TABLE
)
Key points:
- this is the default inheritance strategy (@Inheritance(strategy=InheritanceType.SINGLE_TABLE)
)
- all the classes in a hierarchy are mapped to a single table in a the database
Output example (below is a single table obtained from 4 entities):
Description: This application is a sample of counting and asserting SQL statements triggered "behind the scene". Is very useful to count the SQL statements in order to ensure that your code is not generating more SQLs that you may think (e.g., N+1 can be easily detected by asserting the number of expected statements).
Key points:
- for Maven, in pom.xml
, add dependencies for datasource-proxy
and Vlad Mihalcea's db-util
- create the ProxyDataSourceBuilder
with countQuery()
- reset the counter via SQLStatementCountValidator.reset()
- assert INSERT
, UPDATE
, DELETE
and SELECT
via assertInsert/Update/Delete/Select/Count(long expectedNumberOfSql)
Output example (when the number of expected SQLs is not equal with the reality an exception is thrown):
Description: This application is a sample of enabling the JPA callbacks (Pre/PostPersist
, Pre/PostUpdate
, Pre/PostRemove
and PostLoad
).
Key points:
- in entity, write callback methods and use the proper annotations
- callback methods annotated on the bean class must return void and take no arguments
Description: Instead of a bidirectional @OneToOne
better rely on an unidirectional @OneToOne
and @MapsId
. This application is a proof of concept.
Key points:
- use @MapsId
on child side
- basically, for @OneToOne
associations, this will share the Primary Key with the parent table
Description: Fetching more data than needed is prone to performance penalities. Using DTOs allows us to extract only the needed data. In this application we rely on SqlResultSetMapping
and EntityManager
.
Key points:
- use SqlResultSetMapping
and EntityManager
- for using Spring Data Projections check this recipe
Description: Fetching more data than needed is prone to performance penalities. Using DTOs allows us to extract only the needed data. In this application we rely on SqlResultSetMapping
, NamedNativeQuery
and EntityManager
.
Key points:
- use SqlResultSetMapping
, NamedNativeQuery
and EntityManager
- for using Spring Data Projections check this recipe
Description: Fetching more data than needed is prone to performance penalities. Using DTOs allows us to extract only the needed data. In this application we rely on javax.persistence.Tuple
and native SQL.
Key points:
- use java.persistence.Tuple
and EntityManager.createNativeQuery()
- for using Spring Data Projections check this recipe
Description: Fetching more data than needed is prone to performance penalities. Using DTOs allows us to extract only the needed data. In this application we rely on javax.persistence.Tuple
and JPQL.
Description: Fetching more data than needed is prone to performance penalities. Using DTOs allows us to extract only the needed data. In this application we rely on Constructor Expression and JPQL.
Key points:
- use a proper constructor in the DTO class
- and use a query as select new com.jpa.CarDto(c.name, c.color) from Car c
- for using Spring Data Projections check this recipe
See also:
Dto Via Constructor And Spring Data Query Builder Mechanism
Description: Fetching more data than needed is prone to performance penalities. Using DTOs allows us to extract only the needed data. In this application we rely on Hibernate, ResultTransformer
and native SQL.
Key points:
- use AliasToBeanConstructorResultTransformer
for DTOs without setters, with constructor
- use Transformers.aliasToBean()
for DTOs with setters
- use EntityManager.createNativeQuery()
and unwrap(org.hibernate.query.NativeQuery.class)
- starting with Hibernate 5.2, ResultTransformer
is deprecated, but until a replacement will be available (in Hibernate 6.0) it can be used (read further)
- for using Spring Data Projections check this recipe
Description: Fetching more data than needed is prone to performance penalities. Using DTOs allows us to extract only the needed data. In this application we rely on Hibernate, ResultTransformer
and JPQL.
Key points:
- use AliasToBeanConstructorResultTransformer
for DTOs without setters, with constructor
- use Transformers.aliasToBean()
for DTOs with setters
- use EntityManager.createQuery()
and unwrap(org.hibernate.query.Query.class)
- starting with Hibernate 5.2, ResultTransformer
is deprecated, but until a replacement will be available (in Hibernate 6.0) it can be used (read further)
- for using Spring Data Projections check this recipe
Description: Fetching more data than needed is prone to performance penalities. Using DTOs allows us to extract only the needed data. In this application we rely on Blaze-Persistence entity views.
Key points:
- add in pom.xml dependencies specific to Blaze-Persistence
- configure Blaze-Persistence, CriteriaBuilderFactory
and EntityViewManager
- write an entity view via an interface in Blaze-Persistence fashion
- write a Spring-centric repository by extending EntityViewRepository
- call method of this repository such as, findAll()
, findOne()
, etc
- for using Spring Data Projections check this recipe
Description: This application reveals the possible performance penalties of using @ElementCollection
. In this case, without @OrderColumn
. As you can see in the next recipe (34) adding @OrderColumn
can mitigate some performance penalties.
Key points:
- an @ElementCollection
doesn't have a Primary Key
- an @ElementCollection
is mapped in a separate table
- avoid @ElementCollection
when you have a lot of inserts and deletes in/from it since the database has to delete all existing rows in order to add a new one or delete one
- the more items we have in this table the greater the performance penalty
Description: This application reveals the performance penalties of using @ElementCollection
. In this case, with @OrderColumn
. But, as you can see in this application, by adding @OrderColumn
can mitigate some performance penalties when operations take place near the collection tail (e.g., add/remove at/from the end of the collection). Mainly, all elements situated before the adding/removing entry are left untouched, so the performance penalty can be ignored if we affect rows close to the collection tail.
Key points:
- an @ElementCollection
doesn't have a Primary Key
- an @ElementCollection
is mapped in a separate table
- pefer @ElementCollection
with @OrderColumn
when you have a lot of inserts and deletes from the collection tail
- the more items are inserted/removed from the beginning of this table the greater the performance penalty
Description: The Open-Session in View anti-pattern is activated by default in SpringBoot. If you prefer to use it then it is recommended to mitigate its performance penalties as much as possible. One optimization consist in marking the Connection
as read-only which would allow the database server to avoid writing to the transaction log. Another optimization consist in explicitly setting the lazy properties of the fetched entities when you don't want them to be lazy initialized.
Key points:
- fetch a entity and set the lazy properties explicitly
- you can do this is the service or controller layer, depending where it fits better to your case, but outside of an explicit transaction
- why is this working? why we can set the property of a managed entity and not trigger the flush? well, the answer can be found in the documentation of OpenSessionInViewFilter
which specifies that:
NOTE: This filter will by default not flush the Hibernate Session
, with the flush mode set to FlushMode.NEVER
. It assumes to be used in combination with service layer transactions that care for the flushing: The active transaction manager will temporarily change the flush mode to FlushMode.AUTO
during a read-write transaction, with the flush mode reset to FlushMode.NEVER
at the end of each transaction. If you intend to use this filter without transactions, consider changing the default flush mode (through the "flushMode" property).
Description: This application is a proof of concept for using Spring Projections(DTOs) and inner joins written via JPQL and native SQL (for MySQL).
Key points:
- define serveral entities (e.g., Tournament
and Player
in a bidirectional @OneToMany
relationship)
- populate the database with some test data (e.g., check the file resources/data-mysql.sql
)
- write interfaces (projections) that contains getters for the columns that should be fetched from the database (e.g., TournamentPlayerNameDto
, PlayerRankNameDto
, TournamentIdNameDto
)
- write inner joins queries using JPQL/SQL, for example:
- Query the tournaments of all players (localhost:8080/tournamentsOfPlayersNamesInnerJoinJpql
)
- Query all tournaments that have players with rank smaller or equal to "rank" (localhost:8080/tournamentsIdNameByRankInnerJoinSql
)
Description: This application is a proof of concept for using Spring Projections(DTOs) and left joins written via JPQL and native SQL (for MySQL).
Key points:
- define serveral entities (e.g., Tournament
and Player
in a bidirectional @OneToMany
relationship)
- populate the database with some test data (e.g., check the file resources/data-mysql.sql
)
- write interfaces (projections) that contains getters for the columns that should be fetched from the database (e.g., TournamentPlayerNameDto
)
- write left joins queries using JPQL/SQL, for example:
- Query all players even if they are not in tournaments (localhost:8080/allPlayersLeftJoinJpql
)
- Query all tournaments even if they don't have players (localhost:8080/allTournamentsLeftJoinJpql
)
Description: This application is a proof of concept for using Spring Projections(DTOs) and right joins written via JPQL and native SQL (for MySQL).
Key points:
- define serveral entities (e.g., Tournament
and Player
in a bidirectional @OneToMany
relationship)
- populate the database with some test data (e.g., check the file resources/data-mysql.sql
)
- write interfaces (projections) that contains getters for the columns that should be fetched from the database (e.g., TournamentPlayerNameDto
)
- write right joins queries using JPQL/SQL, for example:
- Query all tournaments even if they don't have players (localhost:8080/allTournamentsRightJoinJpql
)
- Query all players even if they are not in tournaments (localhost:8080/allPlayersRightJoinJpql
)
Description: This application is a proof of concept for using Spring Projections(DTOs) and right joins written via JPQL and native SQL (for PostgreSQL; MySQL does not support FULL JOINS
).
Key points:
- define serveral entities (e.g., Tournament
and Player
in a bidirectional @OneToMany
relationship)
- populate the database with some test data (e.g., check the file resources/data-postgresql.sql
)
- write interfaces (projections) that contains getters for the columns that should be fetched from the database (e.g., TournamentPlayerNameDto
)
- write right joins queries using JPQL/SQL, for example:
- Query all tournaments and players (localhost:8080/allTournamentsAndPlayersFullJoinJpql
)
Description: This application is a proof of concept for using Spring Projections(DTOs) and left excluding joins written via JPQL and native SQL (we use MySQL).
Key points:
- define serveral entities (e.g., Tournament
and Player
in a bidirectional @OneToMany
relationship)
- populate the database with some test data (e.g., check the file resources/data-postgresql.sql
)
- write interfaces (projections) that contains getters for the columns that should be fetched from the database (e.g., TournamentPlayerNameDto
)
- write left excluding joins queries using JPQL/SQL, for example:
- Query all players that are not in tournaments (localhost:8080/allPlayersLeftExcludingJoinJpql
)
- Query all tournaments that don't have players (localhost:8080/allTournamentsLeftExcludingJoinJpql
)
Description: This application is a proof of concept for using Spring Projections(DTOs) and right excluding joins written via JPQL and native SQL (we use MySQL).
Key points:
- define serveral entities (e.g., Tournament
and Player
in a bidirectional @OneToMany
relationship)
- populate the database with some test data (e.g., check the file resources/data-postgresql.sql
)
- write interfaces (projections) that contains getters for the columns that should be fetched from the database (e.g., TournamentPlayerNameDto
)
- write right excluding joins queries using JPQL/SQL, for example:
- Query all players that are not in tournaments (localhost:8080/allPlayersRightExcludingJoinJpql
)
- Query all tournaments that don't have players (localhost:8080/allTournamentsRightExcludingJoinJpql
)
Description: This application is a proof of concept for using Spring Projections(DTOs) and outer excluding joins written via JPQL and native SQL (we use PostgreSQL).
Key points:
- define serveral entities (e.g., Tournament
and Player
in a bidirectional @OneToMany
relationship)
- populate the database with some test data (e.g., check the file resources/data-postgresql.sql
)
- write interfaces (projections) that contains getters for the columns that should be fetched from the database (e.g., TournamentPlayerNameDto
)
- write outer excluding joins queries using JPQL/SQL, for example:
- Query all tournaments that don't have players and all players that don't participate in tournaments (localhost:8080/allTournamentsWithoutPlayersAndViceversaOuterExcludingJoinJpql
)
Description: This application is a proof of concept for using Spring post-commit hooks.
Key points:
- avoid time-consuming task in post-commits since the database connection will remain open until this code finshes
Description: This application is a proof of concept for using Spring Projections (DTOs) and join unrelated entities. Hibernate 5.1 introduced explicit joins on unrelated entities and the syntax and behaviour are similar to SQL JOIN
statements.
Key points:
- define serveral entities (e.g., Author
and Book
unrelated entities)
- populate the database with some test data (e.g., check the file resources/data-mysql.sql
)
- write interfaces (projections) that contains getters for the columns that should be fetched from the database (e.g., BookstoreDto
)
- write joins queries using JPQL/SQL (e.g., queries all authors names and book titles of the given price)
Description: Entities should implement equals()
and hashCode()
as here. The main idea is that Hibernate requires that an entity is equal to itself across all its state transitions (transient, attached, detached and removed). Using Lombok @EqualsAndHashCode
will not respect this requirment.
Key points:
AVOID THESE APPROACHES
- Using Lombok default behavior of @EqualsAndHashCode
(entity: LombokDefaultProduct
, test: LombokDefaultEqualsAndHashCodeTest
)
- Using Lombok @EqualsAndHashCode
with primary key only
(entity: LombokIdProduct
, test: LombokEqualsAndHashCodeWithIdOnlyTest
)
- Rely on default equals()
and hashCode()
(entity: DefaultProduct
, test: DefaultEqualsAndHashCodeTest
)
- Implement equals()
and hashCode()
based only on primary key
(entity: IdProduct
, test: IdEqualsAndHashCodeTest
)
PREFER THESE APPROACHES
- Rely on @NaturalId
(entity: NaturalIdProduct
, test: NaturalIdEqualsAndHashCodeTest
)
- Rely on primary key (entity: GoodProduct
, test: GoodEqualsAndHashCodeTest
)
Good implementation of equals() and hashCode():
Description: Typically, when we get a LazyInitializationException
we tend to modify the relationship fetching type from LAZY
to EAGER
. That is bad! This is a code smell. Best way to avoid this exception is to rely on JOIN FETCH
(if you plan to modify the fetched entities) or JOIN
+ DTOs (if the fetched data is only read). JOIN FETCH
allows associations or collections of values to be initialized along with their parent objects using a single SELECT
. This application is a JOIN FETCH
example with entities. But, with some constraints, JOIN FETCH
can be used with DTOs as well. An example is available here.
Key points:
- define two related entities (e.g., Author
and Book
in a one-to-many lazy bidirectional relationship)
- write a JPQL JOIN FETCH
to fetch an author including his books
- write a JPQL JOIN FETCH
to fetch a book including its author
Description: This is a Spring Boot example based on the following article. Is a functional implementation of the Vlad's example. It is highly recommended to read that article.
Key points:
- Remove the existing database rows that are no longer found in the incoming collection
- Update the existing database rows which can be found in the incoming collection
- Add the rows found in the incoming collection, which cannot be found in the current database snapshot
Description: This is a Spring Boot example that exploits Hibernate 5.2.10 capability of delaying the connection acquisition as needed. Normally, a database connection is aquried immediately after calling a method annotated with @Transactional
. If this method contains some time-consuming tasks before the first SQL statement then the connection is holded for nothing. But, Hibernate 5.2.10 allows us to delay the connection acquisition as needed. This example rely on HikariCP as the default connection pool for Spring Boot.
Key points:
- set spring.datasource.hikari.auto-commit=false
in application.properties
- set spring.jpa.properties.hibernate.connection.provider_disables_autocommit=true
in application.properties
Description: This is a Spring Boot example of using the hi/lo algorithm for fetching 1000 PKs in 10 database roundtrips for batching 1000 inserts in batches of 10 inserts. The hi/lo algorithm is an optimization algorithm for generating sequences of identifiers.
Key points:
- use the SEQUENCE
generator type (e.g., in PostgreSQL)
- configure the hi/lo algorithm as in Player.java
entity
Description: This application is a proof of concept of how is correct to implement the bidirectional @ManyToMany
association.
Key points:
- choose and set the owner of the relationship via mappedBy
- materialize the relationships collections via Set
not List
- use helper methods on the owner of the relationship to keep both sides of the association in sync
- on the owner of the relationship use CascadeType.PERSIST
and CascadeType.MERGE
, but avoid CascadeType.REMOVE/ALL
- on the owner of the relationship set up join table
- @ManyToMany
is lazy by default; keep it this way!
- as entities identifiers, use assigned identifiers (business key, natural key (@NaturalId
)) and/or database-generated identifiers and override properly (on both sides) the equals()
and hashCode()
methods as here
- if toString()
need to be overridden, then pay attention to involve only for the basic attributes fetched when the entity is loaded from the database
Description: This is a Spring Boot example of removing rows in case of a bidirectional @ManyToMany
using a List
and a Set
. The conclusion is that Set
is much better! This applies to unidirectional as well!
Key points:
- using Set
is much more efficent than List
Description: View the query details via log4jdbc
Key points:
- for Maven, in pom.xml
, add log4jdbc
dependency
Description: View the prepared statement binding/extracted parameters via TRACE
Key points:
- in application.properties add: logging.level.org.hibernate.type.descriptor.sql=TRACE
Description: Hibernate Types is a set of extra types not supported by Hibernate by default. One of these types is java.time.YearMonth
. This is a Spring Boot application that uses Hibernate Type to store this YearMonth
in a MySQL database as integer or Date
.
Key points:
- for Maven, add Hibernate Types as a dependency in pom.xml
- in entity use @TypeDef
to map typeClass
to defaultForType
Description: Trying to use SQL functions (MySQL, PostgreSQL, etc) in JPQL queries may result in exceptions if Hibernate will not recognize them and cannot parse the JPQL query. For example, the MySQL, concat_ws
function is not recognized by Hibernate. This application is a Spring Boot application based on Hibernate 5.3, that registers the concat_ws
function via MetadataBuilderContributor
and inform Hibernate about it via, metadata_builder_contributor
property. This example uses @Query
and EntityManager
as well, so you can see two use cases.
Key points:
- use Hibernate 5.3 (or, to be precisely, 5.2.18) (e.g., use Spring Boot 2.1.0.RELEASE)
- implement MetadataBuilderContributor
and register the concat_ws
MySQL function
- in application.properties, set spring.jpa.properties.hibernate.metadata_builder_contributor
to point out to MetadataBuilderContributor
implementation
Description: This application is a sample of logging only slow queries via datasource-proxy. A slow query is a query that has an exection time bigger than a specificed threshold in milliseconds.
Key points:
- for Maven, add in pom.xml
the datasource-proxy
dependency
- create an bean post processor to intercept the DataSource
bean
- wrap the DataSource
bean via ProxyFactory
and an implementation of MethodInterceptor
- choose a threshold in milliseconds
- define a listener and override afterQuery()
If you use the spring-boot-starter-jdbc
or spring-boot-starter-data-jpa
"starters", you automatically get a dependency to HikariCP
Note: The best way to tune the connection pool parameters consist in using Flexy Pool by Vlad Mihalcea. Via Flexy Pool you can find the optim settings that sustain high-performance of your connection pool.
Description: This is a kickoff application that set up HikariCP via application.properties. The jdbcUrl
is set up for a MySQL database. For testing purpose the application uses an ExecutorService
for simulating concurrent users. Check the HickariCP report revealing the connection pool status.
Key points:
- in application.properties, rely on spring.datasource.hikari.*
to configure HikariCP
If you use the spring-boot-starter-jdbc
or spring-boot-starter-data-jpa
"starters", you automatically get a dependency to HikariCP
Note: The best way to tune the connection pool parameters consist in using Flexy Pool by Vlad Mihalcea. Via Flexy Pool you can find the optim settings that sustain high-performance of your connection pool.
Description: This is a kickoff application that set up HikariCP via DataSourceBuilder
. The jdbcUrl
is set up for a MySQL database. For testing purpose the application uses an ExecutorService
for simulating concurrent users. Check the HickariCP report revealing the connection pool status.
Key points:
- in pom.xml, add the spring-boot-configuration-processor
dependency
- in application.properties, configure HikariCP via a custom prefix, e.g., app.datasource.*
- write a @Bean
that returns the DataSource
This application is detailed in this DZone article.
Note: The best way to tune the connection pool parameters consist in using Flexy Pool by Vlad Mihalcea. Via Flexy Pool you can find the optim settings that sustain high-performance of your connection pool.
Description: This is a kickoff application that set up BoneCP via DataSourceBuilder
. The jdbcUrl
is set up for a MySQL database. For testing purpose the application uses an ExecutorService
for simulating concurrent users.
Key points:
- in pom.xml, add the spring-boot-configuration-processor
dependency
- in pom.xml add the BoneCP dependency
- in application.properties, configure BoneCP via a custom prefix, e.g., app.datasource.*
- write a @Bean
that returns the DataSource
Note: The best way to tune the connection pool parameters consist in using Flexy Pool by Vlad Mihalcea. Via Flexy Pool you can find the optim settings that sustain high-performance of your connection pool.
Description: This is a kickoff application that set up ViburDBCP via DataSourceBuilder
. The jdbcUrl
is set up for a MySQL database. For testing purpose the application uses an ExecutorService
for simulating concurrent users.
Key points:
- in pom.xml, add the spring-boot-configuration-processor
dependency
- in pom.xml add the ViburDBCP dependency
- in application.properties, configure ViburDBCP via a custom prefix, e.g., app.datasource.*
- write a @Bean
that returns the DataSource
Note: The best way to tune the connection pool parameters consist in using Flexy Pool by Vlad Mihalcea. Via Flexy Pool you can find the optim settings that sustain high-performance of your connection pool.
Description: This is a kickoff application that set up C3P0 via DataSourceBuilder
. The jdbcUrl
is set up for a MySQL database. For testing purpose the application uses an ExecutorService
for simulating concurrent users.
Key points:
- in pom.xml, add the spring-boot-configuration-processor
dependency
- in pom.xml add the C3P0 dependency
- in application.properties, configure C3P0 via a custom prefix, e.g., app.datasource.*
- write a @Bean
that returns the DataSource
Note: The best way to tune the connection pool parameters consist in using Flexy Pool by Vlad Mihalcea. Via Flexy Pool you can find the optim settings that sustain high-performance of your connection pool.
Description: This is a kickoff application that set up DBCP2 via DataSourceBuilder
. The jdbcUrl
is set up for a MySQL database. For testing purpose the application uses an ExecutorService
for simulating concurrent users.
Key points:
- in pom.xml, add the spring-boot-configuration-processor
dependency
- in pom.xml add the DBCP2 dependency
- in application.properties, configure DBCP2 via a custom prefix, e.g., app.datasource.*
- write a @Bean
that returns the DataSource
Note: The best way to tune the connection pool parameters consist in using Flexy Pool by Vlad Mihalcea. Via Flexy Pool you can find the optim settings that sustain high-performance of your connection pool.
Description: This is a kickoff application that set up Tomcat Connection Pool via DataSourceBuilder
. The jdbcUrl
is set up for a MySQL database. For testing purpose the application uses an ExecutorService
for simulating concurrent users.
Key points:
- in pom.xml, add the spring-boot-configuration-processor
dependency
- in pom.xml add the Tomcat Connection Pool dependency
- in application.properties, configure Tomcat Connection Pool via a custom prefix, e.g., app.datasource.*
- write a @Bean
that returns the DataSource
Note: The best way to tune the connection pool parameters consist in using Flexy Pool by Vlad Mihalcea. Via Flexy Pool you can find the optim settings that sustain high-performance of your connection pool.
Description: This is a kickoff application that uses two data sources (two MySQL databases, one named players_db
and one named coaches_db
) with two connection pools (each database uses its own HikariCP connection pool with different settings). Based on the above recipes is pretty easy to configure two connection pools from two different providers as well.
Key points:
- in pom.xml, add the spring-boot-configuration-processor
dependency
- in application.properties, configure two HikariCP connection pools via a two custom prefixes, e.g., app.datasource.ds1
and app.datasource.ds2
- write a @Bean
that returns the first DataSource
and mark it as @Primary
- write another @Bean
that returns the second DataSource
- configure two EntityManagerFactory
and point out the packages to scan for each of them
- put the domains and repositories for each EntityManager
in the right packages
Note: If you want yo provide a Fluent API without altering setters then consider this recipe.
Description: This is a sample application that alter the entities setters methods in order to empower a Fluent API.
Key points:
- in entities, return this
instead of void
in setters
Note: If you want yo provide a Fluent API by altering setters then consider this recipe.
Description: This is a sample application that add in entities additional methods (e.g., for setName
, we add name
) methods in order to empower a Fluent API.
Key points:
- in entities, add for each setter an additional method that return this
instead of void
Available implementations::
- This is a thin implementation based on a hard-coded SQL:
"SELECT e FROM " + entityClass.getSimpleName() + " e;"
- This is just another minimalist implementation based on
CriteriaBuilder
instead of hard-coded SQL - This is an implementation that allows us to provide a
Sort
, so sorting results is possible - This is an implementation that allows us to provide a
Sort
and a Spring DataSpecification
- This is an implementation that allows us to provide a
Sort
, aLockModeType
, aQueryHints
and a Spring DataSpecification
- This is an implementation that allows us to provide a Spring Data
Pageable
and/orSpecification
by extending theSimpleJpaRepository
from Spring Data. Bascially, this implementation is the only one that returnsPage<T>
instead ofSlice<T>
, but it doesn't trigger the extraSELECT COUNT
since it was eliminated by overriding thePage<T> readPage(...)
method fromSimpleJpaRepository
. The main drawback is that by returing aPage<T>
you don't know if there is a next page or the current one is the last. Nevertheless, there are workarounds to have this as well. In this implementation you cannot setLockModeType
or query hints.
Story: Spring Boot provides an offset based built-in paging mechanism that returns a Page
or Slice
. Each of these APIs represents a page of data and some metadata. The main difference is that Page
contains the total number of records, while Slice
can only tell if there is another page available. For Page
, Spring Boot provides a findAll()
method capable to take as arguments a Pageable
and/or a Specification
. In order to populate a Page
containing the total number of records, this method triggers an SELECT COUNT
extra-query next to the query used to fetch the current page . This can be a performance penalty since the SELECT COUNT
query is triggered every time we request a page. In order to avoid this extra-query, Spring Boot provides a more relaxed API, the Slice
API. Using Slice
instead of Page
removes the need of this extra SELECT COUNT
query and returns the page (records) and some metadata without the total number of records. So, while Slice
doesn't know the total number of records, it still can tell if there is another page available after the current one or this is the last page. The problem is that Slice
work fine for queries containing the SQL, WHERE
clause (including those that uses the query builder mechanism built into Spring Data), but it doesn't work for findAll()
. This method will still return a Page
instead of Slice
therefore the SELECT COUNT
query is triggered for Slice<T> findAll(...);
.
Description: This is a suite of samples applications that provides different versions of a Slice<T> findAll(...)
method. We have from a minimalist implementation that relies on a hardcoded query as: "SELECT e FROM " + entityClass.getSimpleName() + " e";
(this recipe), to a custom implementation that supports sorting, specification, lock mode and query hints to an implementation that relies on extending SimpleJpaRepository
.
Key points:
- write an abstract
class that expose the Slice<T> findAll(...)
methods (SlicePagingRepositoryImplementation
)
- implement the findAll()
methods to return Slice<T>
(or Page<T>
, but without the total number of elements)
- return a SliceImpl
(Slice<T>
) or a PageImpl
(Page<T>
) without the total number of elements
- implement a new readSlice()
method or override the SimpleJpaRepository#readPage()
page to avoid SELECT COUNT
- pass the entity class (e.g., Player.class
) to this abstract
class via a class repository (PlayerRepository
)
Description: When we rely on an offset paging we have the performance penalty induced by throwing away n records before reached the desired offset. Larger n leads to a significant performance penalty. But, this is not the only performance penalty. Most of the time we want to count the total number of rows to calculate the total number of possible pages, so this is an extra SELECT COUNT
. So, if we don't want to go with keyset pagination and avoid counting that total number of records, which can be very costly, we have to tacke this performance penalty somehow. For databases vendors that support Window Functions there is a solution relying on COUNT(*) OVER()
as in this application that uses this window function in a native query against MySQL 8.
Key points:
- create a DTO projection to cover the extra-column added by the COUNT(*) OVER()
window function
- write a native query relying on this window function
Note: For a list of pros and cons of offset vs keyset please check my book: Java Persistence Performance Illustrated Guide.
Description: When we rely on an offset paging we have the performance penalty induced by throwing away n records before reached the desired offset. Larger n leads to a significant performance penalty. When we have a large n is better to rely on keyset pagination which maintain a "constant" time for large datasets. In order to understand how bad offset can perform please check this article:
Screenshot from that article (offset pagination):
Need to know if there are more records?
By its nature, keyset doesn't use a SELECT COUNT
to fetch the number of total records. But, we a little tweak we can easily say if there are more records, therefore to show a button of type Next Page
. Mainly, if you need such a thing then consider this application.
public Map<List<Player>, Boolean> fetchNextSlice(long id, int limit) {
     List<Player> players = playerRepository.fetchAllPlayers(id, limit + 1);
     if(players.size() == (limit + 1)) {
          players.remove(players.size() -1);
          return Collections.singletonMap(players, true);
     }
     return Collections.singletonMap(players, false);
}
A Previous Page
button can be implemented easily based on the first record.
Key points:
- choose a column to act as the latest visited record (e.g., id
)
- use this column in the WHERE
clause of your SQL
Note: For a list of pros and cons of offset vs keyset please check my book: Java Persistence Performance Illustrated Guide.
Description: When we rely on an offset paging we have the performance penalty induced by throwing away n records before reached the desired offset. Larger n leads to a significant performance penalty. Another penalty is the extra-SELECT
needed to count the total number of records. But, for small datasets, offset and keysey provides almost the same performances. Spring Boot provides built-in support for offset pagination via the Page
API, therefore it is very easy to use it in an application.
Important note: This application extract records as entities, but if all you want to do is to read this data as pages then consider DTOs to avoid consuming memory and CPU for nothing. As a rule, extract entites only if you plan to modify them. In this case, we need a native SQL or another approach instead of Page<T>
.
But: If offset pagination is causing you performance issues then please check recipes: 70 (slice technique for find all records), 71 (offset with window functions) and 72 (keyset pagination).
Key points:
- write a repository that extends PagingAndSortingRepository
- call or write methods that returns Page
Examples:
- call the built-in findAll(Pageable)
without sorting:
repository.findAll(PageRequest.of(page, size));
- call the built-in findAll(Pageable)
with sorting:
repository.findAll(PageRequest.of(page, size, new Sort(Sort.Direction.ASC, "name")));
- use Spring Data query creation to define new methods in your repository:
Page<Player> findByName(String name, Pageable pageable);
Page<Player> queryFirst10ByName(String name, Pageable pageable);
Description: Let's suppose that we have a one-to-many relationship between Author
and Book
entities. When we save an author, we save his/her books as well thanks to cascading all/persist. We want to create a bunch of authors with books and save them in the database (e.g., a MySQL database) using the batch technique. By default, this will result in batching each author and the books per author. In order to batch authors and books, we need to order inserts as in this application.
Key points:
- beside all setting specific to batching inserts in MySQL, we need to set up in application.properties the following property: spring.jpa.properties.hibernate.order_inserts=true
Example without ordered inserts:
Implementations:
Description: Batch updates in MySQL.
Key points:
- in application.properties
set spring.jpa.properties.hibernate.jdbc.batch_size
- in application.properties
set JDBC URL with rewriteBatchedStatements=true
(optimization for MySQL, statements get rewritten into a single String
buffer and sent in a single request)
- in application.properties
set JDBC URL with cachePrepStmts=true
(enable caching and is useful if you decide to set prepStmtCacheSize
, prepStmtCacheSqlLimit
, etc as well; without this setting the cache is disabled)
- in application.properties
set JDBC URL with useServerPrepStmts=true
(this way you switch to server-side prepared statements (may lead to signnificant performance boost))
- in case of using a parent-child relationship with cascade all/persist (e.g. one-to-many, many-to-many) then consider to set up spring.jpa.properties.hibernate.order_updates=true
to optimize the batching by ordering updates
- before Hibernate 5, we need to set in application.properties
a setting for enabling batching for versioned entities during update and delete operations (entities that contains @Version
for implicit optimistic locking); this setting is: spring.jpa.properties.hibernate.jdbc.batch_versioned_data=true
; starting with Hibernate 5, this setting should be true
by default
Output example for single entity:
Output example for parent-child relationship:
Description: Batch deletes that don't involve associations in MySQL.
Note: Spring deleteAllInBatch()
and deleteInBatch()
don't use classical delete batching. They rely on Query.executeUpdate()
to trigger bulk operations. These operations are fast, but Hibernate doesn’t know which entities are removed, therefore, the persistent context is not synchronized accordingly. The first one simply triggers a delete from entity_name
statement and is very useful for deleting all records. The second one triggers a delete from entity_name where id=? or id=? or id=? ...
statement, therefore, is prone to cause issues if the generated DELETE
statement exceedes the maximum accepted size. This drawback can be controlled by deleting the data in chunks that results in DELETE
statements that don't exceed the maximum accepted size. The maximum accepted size depends on RDBMS (e.g., for MySQL, execute SHOW VARIABLES LIKE 'max_allowed_packet';
). Nevertheless, this approach is very fast. Is faster than classical delete batching which can be achieved via the deleteAll()
, deleteAll(Iterable<? extends T> entities)
or delete()
method. Behind the scene, the two flavors of deleteAll()
relies on delete()
. The delete()
/deleteAll()
methods rely on EntityManager.remove()
therefore the persistent context is synchronized accordingly.
Key points for classical delete batching:
- for classical delete batching rely on deleteAll()
, deleteAll(Iterable<? extends T> entities)
or delete()
method
- in application.properties
set spring.jpa.properties.hibernate.jdbc.batch_size
- in application.properties
set JDBC URL with rewriteBatchedStatements=true
(optimization for MySQL, statements get rewritten into a single String
buffer and sent in a single request)
- in application.properties
set JDBC URL with cachePrepStmts=true
(enable caching and is useful if you decide to set prepStmtCacheSize
, prepStmtCacheSqlLimit
, etc as well; without this setting the cache is disabled)
- in application.properties
set JDBC URL with useServerPrepStmts=true
(this way you switch to server-side prepared statements (may lead to signnificant performance boost))
- before Hibernate 5, we need to set in application.properties
a setting for enabling batching for versioned entities during update and delete operations (entities that contains @Version
for implicit optimistic locking); this setting is: spring.jpa.properties.hibernate.jdbc.batch_versioned_data=true
; starting with Hibernate 5, this setting should be true
by default
Description: Batch deletes in MySQL via orphanRemoval=true
.
Note: Spring deleteAllInBatch()
and deleteInBatch()
don't use batching and don't take advantage of orphanRemoval=true
. They trigger bulk operations and the persistent context is not synchronized accordingly. The first one simply triggers a delete from entity_name
statement, while the second one triggers a delete from entity_name where id=? or id=? or id=? ...
statement. Using these methods for deleting parent-entities and the associated entites (child-entities) requires explicit calls for both sides. For batching rely on deleteAll()
, deleteAll(Iterable<? extends T> entities)
or even better, on delete()
method. Behind the scene, deleteAll()
methods uses delete()
. The delete()
and deleteAll()
methods rely on EntityManager.remove()
, therefore, the persistent context is synchronized.
Key points for using deleteAll()/delete()
:
- in this example, we have a Author
entity and each author can have several Book
(one-to-many)
- first, we use orphanRemoval=true
and CascadeType.ALL
- second, we dissociate all Book
from the corresponding Author
- third, we explicitly (manually) flush the persistent context; is time for orphanRemoval=true
to enter into the scene; thanks to this setting, all disassociated books will be deleted; the generated DELETE
statements are batched (if orphanRemoval
is set to false
, a bunch of updates will be executed instead of deletes)
- forth, we delete all Author
via the deleteAll()
or delete()
method (since we have dissaciated all Book
, the Author
deletion will take advantage of batching as well)
Description: Batch deletes in MySQL via ON DELETE CASCADE
. Auto-generated database schema will contain the ON DELETE CASCADE
directive.
Note: Spring deleteAllInBatch()
and deleteInBatch()
don't use classical delete batching. They trigger bulk operations via Query.executeUpdate()
, therefore, the persistent context is not synchronized accordingly. The first one simply triggers a delete from entity_name
statement, while the second one triggers a delete from entity_name where id=? or id=? or id=? ...
statement. Both of them take advantage on ON DELETE CASCADE
and are very efficient. For classical delete batching rely on deleteAll()
, deleteAll(Iterable<? extends T> entities)
or delete()
method. Behind the scene, the two flavors of deleteAll()
relies on delete()
. Mixing batching with database automatic actions (ON DELETE CASCADE
) will result in a partially synchronized persistent context.
Key points:
- in this application, we have a Author
entity and each author can have several Book
(one-to-many)
- first, we remove orphanRemoval
or set it to false
- second, we use only CascadeType.PERSIST
and CascadeType.MERGE
- third, we set @OnDelete(action = OnDeleteAction.CASCADE)
next to @OneToMany
- fourth, we set spring.jpa.properties.hibernate.dialect
to org.hibernate.dialect.MySQL5InnoDBDialect
- fifth, we run through each deleteFoo()
method
Output example:
Alternative implementation: In case that you want to avoid extending SimpleJpaRepository
check this implementation.
Description: This is a SpringBoot application that maps a natural business key using Hibernate @NaturalId
.
Key points:
- in the entity (e.g., Product
), mark the properties (business keys) that should act as natural IDs with @NaturalId
; commonly, there is a single such property, but multiple are suppored as well as here.
- for non-mutable ids, mark the columns as @NaturalId(mutable = false)
and @Column(nullable = false, updatable = false, unique = true, ...)
- for mutable ids, mark the columns as @NaturalId(mutable = true)
and @Column(nullable = false, updatable = true, unique = true, ...)
- override the equals()
and hashCode()
using the natural id(s)
- define a @NoRepositoryBean
interface (NaturalRepository
) to define two methods, named findBySimpleNaturalId()
and findByNaturalId()
- provide an implementation for this interface (NaturalRepositoryImpl
) relying on Hibernate, Session
, bySimpleNaturalId()
and byNaturalId()
methods
- use @EnableJpaRepositories(repositoryBaseClass = NaturalRepositoryImpl.class)
to register this implementation as the base class
- for the entity, write a classic repository
- inject this class in your services and call findBySimpleNaturalId()
or findByNaturalId()
Description: This is a Spring Boot application that uses P6Spy. P6Spy is a framework that enables database data to be seamlessly intercepted and logged with no code changes to the application.
Key points:
- in pom.xml, add the P6Spy Maven dependency
- in application.properties, set up JDBC URL as, jdbc:p6spy:mysql://localhost:3306/db_users
- in application.properties, set up driver class name as, com.p6spy.engine.spy.P6SpyDriver
- in the application root folder add the file spy.properties (this file contains P6Spy configurations); in this application, the logs will be outputed to console, but you can easy switch to a file; more details about P6Spy configurations can be found in documentation
Note: Optimistic locking via @Version
works for detached entities as well.
Description: This is a Spring Boot application that simulates a scenario that leads to an optimistic locking exception. When such exception occur, the application retry the corresponding transaction via db-util library developed by Vlad Mihalcea.
Key points:
- in pom.xml
, add the db-util
dependency
- configure the OptimisticConcurrencyControlAspect
bean
- mark the method (not annotated with @Transactional
) that is prone to throw (or that calls a method that is prone to throw (this method can be annotated with @Transactional
)) an optimistic locking exception with @Retry(times = 10, on = OptimisticLockingFailureException.class)
Note: Optimistic locking via Hibernate version-less doesn't work for detached entities (don't close the persistent context).
Description: This is a Spring Boot application that simulates a scenario that leads to an optimistic locking exception (e.g., in Spring Boot, OptimisticLockingFailureException
) via Hibernate version-less optimistic locking. When such exception occur, the application retry the corresponding transaction via db-util library developed by Vlad Mihalcea.
Key points:
- in pom.xml
, add the db-util
library dependency
- configure the OptimisticConcurrencyControlAspect
bean
- annotate the corresponding entity (e.g., Inventory
) with @DynamicUpdate
and @OptimisticLocking(type = OptimisticLockType.DIRTY)
- mark the method (not annotated with @Transactional
) that is prone to throw (or that calls a method that is prone to throw (this method can be annotated with @Transactional
)) an optimistic locking exception with @Retry(times = 10, on = OptimisticLockingFailureException.class)
Note: You may also like to read the recipe, "How To Create DTOs Via Spring Data Projections"
Description: Fetch only the needed data from the database via Spring Data Projections (DTOs) and enrich the result via virtual properties.
Key points:
- we fetch from the database only the user name
and city
- in the projection interface, UserDetail
, use the @Value
and Spring SpEL to point to a backing property from the domain model (in this case, the domain model property city
is exposed via the virtual property livingin
)
- in the projection interface, UserDetail
, use the @Value
and Spring SpEL to enrich the result with two virtual properties that don't have a match in the domain model (in this case, sessionid
and status
)
Description: Spring Data comes with the query creation mechanism for JPA that is capable to interpret a query method name and convert it into a SQL query. This is possible as long as we respect the naming conventions of this mechanism. This is an application that exploit this mechanism to write queries that limit the result size. Basically, the name of the query method instructs Spring Data how to add the LIMIT
(or similar clauses depending on the RDBMS) clause to the generated SQL queries.
Key points:
- define a Spring Data classic repository (e.g., AuthorRepository
)
- write query methods respecting the query creation mechanism for JPA naming conventions
Examples:
- List<Author> findFirst5ByAge(int age);
- List<Author> findFirst5ByAgeGreaterThanEqual(int age);
- List<Author> findFirst5ByAgeLessThan(int age);
- List<Author> findFirst5ByAgeOrderByNameDesc(int age);
- List<Author> findFirst5ByGenreOrderByAgeAsc(String genre);
- List<Author> findFirst5ByAgeGreaterThanEqualOrderByNameAsc(int age);
- List<Author> findFirst5ByGenreAndAgeLessThanOrderByNameDesc(String genre, int age);
- List<AuthorDto> findFirst5ByOrderByAgeAsc();
- Page<Author> queryFirst10ByName(String name, Pageable p);
- Slice<Author> findFirst10ByName(String name, Pageable p);
The list of supported keywords is listed below:
Note: As a rule, in real applications avoid generating schema via, hibernate.ddl-auto
. Use schema-.sql
file or better Flyway
or Liquibase
.
Description: This application is an example of using schema-.sql
to generate a schema(database) in MySQL.
Key points:
- in application.properties
, set the JDBC URL. E.g., spring.datasource.url=jdbc:mysql://localhost:3306/db_cars?createDatabaseIfNotExist=true
- in application.properties
, disable DDL auto, e.g., spring.jpa.hibernate.ddl-auto=none
- in aaplication.properties
, instruct Spring Boot to initialize the schema from schema-mysql.sql
file
Note: As a rule, in real applications avoid generating schema via, hibernate.ddl-auto
. Use schema-.sql
file or better Flyway
or Liquibase
.
Description: This application is an example of using schema-.sql
to generate two schemas(databases) in MySQL. The tables and schemas are matched at entity mapping via @Table
.
Key points:
- in application.properties
, set the JDBC URL without schema, e.g., spring.datasource.url=jdbc:mysql://localhost:3306
- in application.properties
, disable DDL auto, e.g., spring.jpa.hibernate.ddl-auto=none
- in aaplication.properties
, instruct Spring Boot to initialize the schema from schema-mysql.sql
file
- in Car
entity, specify that the schema is db_cars
and the table is, lux_cars
, @Table(name = "lux_cars", catalog = "db_cars")
- in Driver
entity, specify that the schema is db_drivers
and the table is, lux_drivers
, @Table(name = "lux_drivers", catalog = "db_drivers")
Output example:
- Persisting a
Car
results in the following SQL:insert into db_cars.lux_cars (name) values (?)
- Persisting a
Driver
results the following SQL:insert into db_drivers.lux_drivers (name) values (?)
Note: For web-applications, pagination should be the way to go, not streaming. But, if you choose streaming then keep in mind the golden rule: keep th result set as small as posible. Also, keep in mind that the Execution Plan might not be as efficient as when using SQL-level pagination.
Description: This application is an example of streaming the result set via Spring Data and MySQL. This example can be adopted for databases that fetches the entire result set in a single roundtrip causing performance penalties.
Key points:
- rely on forward-only result set (default in Spring Data)
- rely on read-only statement (add @Transactional(readOnly=true)
)
- set the fetch-size set (e.g. 30, or row-by-row; Integer.MIN_VALUE
(recommended in MySQL))
Note: For production don't rely on hibernate.ddl-auto
to create your schema. Set hibernate.ddl-auto
to none
or validate
and rely on Flyway or Liquibase.
Description: This application is an example of migrating a MySQL schema when the schema exists (is created before migration).
Key points:
- for Maven, in pom.xml, add the Flyway dependency
- in application.properties, set spring.jpa.hibernate.ddl-auto=none
- in application.properties, set the JDBC URL with the schema, e.g., jdbc:mysql://localhost:3306/db_cars
- each SQL file containing the schema update add it in classpath:db/migration
- each SQL file name it as V1.1__Description.sql
, V1.2__Description.sql
, ...
Note: For production don't rely on hibernate.ddl-auto
to create your schema. Set hibernate.ddl-auto
to none
or validate
and rely on Flyway or Liquibase.
Description: These two applications are kickoffs of using Flyway in SpringBoot for auto-creating and migrating database schema in MySQL. The main difference between them is that in the first one we need to indicate the used schema via @Table(catalog = '...')
since is not present in the JDBC URL. Basically, we remove the schema name from connection URL and use flyway.schemas
option to provide the schema name and Flyway will create the missing schema for us. The second application is more friendly, since it doesn't have this restriction because it set the database name in the JDBC URL as usual, and uses the MySQL specific createDatabaseIfNotExist=true
for creating the missing schema before Flyway enters into the scene.
First application key points (using "spring.flyway.schemas"):
- for Maven, in pom.xml, add the Flyway dependency
- in application.properties, set spring.jpa.hibernate.ddl-auto=none
- in application.properties, set the JDBC URL without specifying the schema, e.g., jdbc:mysql://localhost:3306/
- in application.properties, set the schemas that should be migrated, e.g., spring.flyway.schemas=db_cars
- each SQL file containing the schema update add it in classpath:db/migration
- each SQL file name it as V1.1__Description.sql
, V1.2__Description.sql
, ...
Second application key points (using "createDatabaseIfNotExist=true"):
- for Maven, in pom.xml, add the Flyway dependency
- in application.properties, set spring.jpa.hibernate.ddl-auto=none
- in application.properties, set the JDBC URL with the schema, e.g., jdbc:mysql://localhost:3306/db_cars?createDatabaseIfNotExist=true
- each SQL file containing the schema update add it in classpath:db/migration
- each SQL file name it as V1.1__Description.sql
, V1.2__Description.sql
, ...
Output of migrationg history example:
Note: For production don't rely on hibernate.ddl-auto
to create your schema. Set hibernate.ddl-auto
to none
or validate
and rely on Flyway or Liquibase.
Description: This application is an example of auto-creating and migrating schemas for MySQL and PostgreSQL. In addition, each data source uses its own HikariCP connection pool. In case of MySQL, where schema=database, we auto-create the schema (players_db
) based on createDatabaseIfNotExist=true
. In case of PostgreSQL, where a database can have multiple schemas, we use the default postgres
database and auto-create in it the schema, coaches_db
. For this we rely on Flyway, which is capable to create a missing schema.
Key points:
- for Maven, in pom.xml, add the Flyway dependency
- in application.properties, configure the JDBC URL for MySQL as, jdbc:mysql://localhost:3306/players_db?createDatabaseIfNotExist=true&useSSL=false
and for PostgreSQL as, jdbc:postgresql://localhost:5432/postgres?currentSchema=coaches_db
- in application.properties, set spring.flyway.enabled=false
to disable default behavior
- programmatically create a DataSource
for MySQL and one for PostgreSQL
- programmatically create a FlywayDataSource
for MySQL and one for PostgreSQL
- programmatically create an EntityManagerFactory
for MySQL and one for PostgreSQL
- for MySQL, place the migration SQLs files in db\migration\mysql
- for PostgreSQL, place the migration SQLs files in db\migration\postgresql
Note: For production don't rely on hibernate.ddl-auto
to create your schema. Set hibernate.ddl-auto
to none
or validate
and rely on Flyway or Liquibase.
Description: This application is an example of auto-creating and migrating two schemas in PostgreSQL using Flyway. In addition, each data source uses its own HikariCP connection pool. In case of PostgreSQL, where a database can have multiple schemas, we use the default postgres
database and auto-create in it two schemas, players_db
and coaches_db
. For this we rely on Flyway, which is capable to create the missing schemas.
Key points:
- for Maven, in pom.xml, add the Flyway dependency
- in application.properties, configure the JDBC URL for players_db
as jdbc:postgresql://localhost:5432/postgres?currentSchema=players_db
and for coaches_db
as jdbc:postgresql://localhost:5432/postgres?currentSchema=coaches_db
- in application.properties, set spring.flyway.enabled=false
to disable default behavior
- programmatically create two DataSource
, one for players_db
and one for coaches_db
- programmatically create two FlywayDataSource
, one for players_db
and one for coaches_db
- programmatically create two EntityManagerFactory
, one for players_db
and one for coaches_db
- for players_db
, place the migration SQLs files in db\migration\playersdb
- for coaches_db
, place the migration SQLs files in db\migration\coachesdb
Description: This application is an example applying JOIN FETCH
to fetch an @ElementCollection
.
Key points:
- by default, @ElementCollection
is loaded lazy, keep it lazy
- use JOIN FETCH
in the repository
Note: Consider using @Subselect
only if using DTO + extra queries or map a database view to an entity is not a solution.
Description: This application is an example of mapping an entity to a query via Hibernate, @Subselect
. Mainly, we have two entities in a bidirectional one-to-many association. An Author
has wrote several Book
. The idea is to write a read-only query to fetch from Author
only some fields (e.g., DTO), but to have the posibility to call getBooks()
and fetch the Book
in a lazy manner as well. As you know, a classic DTO cannot be used, since such DTO is not managed and we cannot fetch managed associations. Via Hibernate, @Subselect
we can map a read-only, immutable entity to a query. Being an entity, it can lazy load the managed associations.
Key points:
- define a new entity that contains only the needed fields from the Author
(including association to Book
)
- for these fields, define only getters
- mark the entity as @Immutable
since no write operations are allowed
- flush pending state transitions for the used entities by @Synchronize
- use @Subselect
to write the needed query, map an entity to an SQL query
Description: This application is an example of using Hibernate soft deletes in a Spring Boot application.
Key points:
- in entities (e.g., Tournament
entity) that should take advantage of soft deletes define a dedicated column to store the deletion status (e.g., deleted
)
- these entities should be marked with Hibernate, @Where
annotation like this: @Where(clause = "deleted = false")
- these entities should be marked with Hibernate, @SQLDelete
annotation to trigger UPDATE
SQLs in place of DELETE
SQLs, as follows: @SQLDelete(sql = "UPDATE tournament SET deleted = true WHERE id = ?")
- for fetching all entities including those marked as deleted or for fetching only the entities marked as deleted we need to rely on SQL native queries
If you use the spring-boot-starter-jdbc
or spring-boot-starter-data-jpa
"starters", you automatically get a dependency to HikariCP
Note: The best way to tune the connection pool parameters consist in using Flexy Pool by Vlad Mihalcea. Via Flexy Pool you can find the optim settings that sustain high-performance of your connection pool.
Description: This is a kickoff application that set up HikariCP via DataSourceBuilder
. The jdbcUrl
is set up for a MySQL database. For testing purpose the application uses an ExecutorService
for simulating concurrent users. Check the HickariCP report revealing the connection pool status.
Key points:
- write a @Bean
that returns the DataSource
configured programmatically via DataSourceBuilder
Description: Auditing is useful for maintaining history records. This can later help us in tracking user activities.
Key points:
- create an abstract base entity (e.g., BaseEntity
) and annotate it with @MappedSuperclass
and @EntityListeners({AuditingEntityListener.class})
- in this base entity, add the following fields that will be automatically persisted: @CreatedDate protected LocalDateTime createdAt;
, @LastModifiedDate protected LocalDateTime updatedAt;
, @CreatedBy protected U createdBy;
and @LastModifiedBy protected U modifiedBy;
- enable auditing via @EnableJpaAuditing(auditorAwareRef = "auditorAware")
- provide an implementation for AuditorAware
(this is needed for persisting the user that performed the modification; use Spring Security to return the currently logged-in user)
- expose this implementation via @Bean
- entites that should be audited should extend the base entity
Description: Auditing is useful for maintaining history records. This can later help us in tracking user activities.
Key points:
- in pom.xml
add the dependency hibernate-envers
- each entity that should be audited should be annotated with @Audited
- optionally, annotate entities with @AuditTable
to rename the table used for auditing
Description: By default, the attributes of an entity are loaded eager (all at once). This application is an alternative to Attribute Lazy Loading from here. This application uses a base class to isolate the attributes that should be loaded eagerly and subentities (entities that extends the base class) for isolating the attributes that should be loaded on demand.
Key points:
- create the base class (this is not an entity), BaseAuthor
, and annotate it with @MappedSuperclass
- create AuthorShallow
subentity of BaseAuthor
and don't add any attribute in it (this will inherit the attributes from the superclass)
- create AuthorDeep
subentity of BaseAuthor
and add to it the attributes that should be loaded on demand (e.g., avatar
)
- map both subentities to the same table via @Table(name = "author")
- provide the typical repositories, AuthorShallowRepository
and AuthorDeepRepository
Run the following requests (via BookstoreController):
- fetch all authors shallow (without avatars): localhost:8080/authors/shallow
- fetch all authors deep (with avatars): localhost:8080/authors/deep
Description: Fetching more data than needed is prone to performance penalities. Using DTOs allows us to extract only the needed data. In this application we rely on Constructor Expression and JPQL.
Key points:
- write a proper constructor in the DTO class
- rely on Spring Data Query Builder Mechanism for expression the SQL
- for using Spring Data Projections check this recipe
See also:
Dto Via Constructor Expression and JPQL
Description: Combining JOIN FETCH
and DTOs can be done under several constrains. Mainly, the JPQL containing the JOIN FETCH
cannot be used to fetch only some columns from the involved entities (in such cases, JOIN
is the proper choice). It must fetch all attributes of the involved entities.
Key points:
- define two related entities (e.g., Author
and Book
in a one-to-many lazy bidirectional relationship)
- define the proper DTOs classes (e.g., BookDto
and AuthorDto
)
- the BookDto
and AuthorDto
may map only the needed columns, but the triggered SQL will fetch all of them anyway
- write a JPQL JOIN FETCH
to fetch an author including his books
Constrains:
- this is ok: SELECT a FROM Author a JOIN FETCH a.books
- this is not ok: SELECT a.age as age FROM Author a JOIN FETCH a.books
-> org.hibernate.QueryException: query specified join fetching, but the owner of the fetched association was not present in the select list
- this is not ok: SELECT a FROM Author a JOIN FETCH a.books.title
-> org.hibernate.QueryException: illegal attempt to dereference collection [author0_.id.books] with element property reference [title]
Description: Let's assume that we have two entities engaged in a one-to-many (or many-to-many) lazy bidirectional (or unidirectional) relationhip (e.g., Author
has more Book
). And, we want to trigger a single SELECT
that fetches all Author
and the corresponding Book
. This is a job for JOIN FETCH
which is converted behind the scene into a INNER JOIN
. Being an INNER JOIN
, the SQL will return only Author
that have Book
. If we want to return all Author
, including those that doesn't have Book
, then we can rely on LEFT JOIN FETCH
. Similar, we can fetch all Book
, including those with no registered Author
.
Key points:
- define two related entities (e.g., Author
and Book
in a one-to-many lazy bidirectional relationship)
- write a JPQL LEFT JOIN FETCH
to fetch all authors and books (fetch authors even if they don't have registered books)
- write a JPQL LEFT JOIN FETCH
to fetch all books and authors (fetch books even if they don't have registered authors)
Description: This is an application meant to reveal the differences between JOIN
and JOIN FETCH
. The important thing to keep in mind is that, in case of LAZY
fetching, JOIN
will not be capable to initialize the associations/collections along with their parent objects using a single SQL SELECT
. On the other hand, JOIN FETCH
is capable to accomplish this kind of task. But, don't underestimate JOIN
, because JOIN
is the proper choice when we need to combine/join the columns of two (or more) tables in the same query, but we don't need to initialize the association on the returned entity (e.g., very useful for fetching DTOs).
Key points:
- define two related entities (e.g., Author
and Book
in a one-to-many lazy bidirectional relationship)
- write a JPQL JOIN
and JOIN FETCH
to fetch an author including his books
- write a JPQL JOIN
and JOIN FETCH
to fetch a book including its author
Notice that:
- via JOIN
, fetching each Author
of a Book
(or each Book
of an Author
) may require additional SELECT(s)
being prone to N+1 performance penalty
- via JOIN FETCH
, fetching each Author
of a Book
(or each Book
of an Author
) required a single SELECT
Description: If, for any reason, you need an entity in your Spring projection (DTO), then this application shows you how to do it via an example. In this case, there are two entities, Author
and Book
, involved in a lazy bidirectional one-to-many association (it can be other association as well, or even no materialized association). And, we want to fetch in a Spring projection the authors as entities, Author
, and the title
of the books.
Key points:
- define two related entities (e.g., Author
and Book
in a one-to-many lazy bidirectional relationship)
- define the proper Spring projection having public Author getAuthor()
and public String getTitle()
- write a JPQL to fetch data
Description: If, for any reason, you need an entity in your Spring projection (DTO), then this application shows you how to do it via an example. In this case, there are two entities, Author
and Book
, that have no materialized association between them, but, they share the genre
attribute. We use this attribute to join authors with books via JPQL. And, we want to fetch in a Spring projection the authors as entities, Author
, and the title
of the books.
Key points:
- define two unrelated entities (e.g., Author
and Book
)
- define the proper Spring projection having public Author getAuthor()
and public String getTitle()
- write a JPQL to fetch data
Description: Let's assume that we have two entities, Author
and Book
. There is no materialized association between them, but, both entities shares an attribute named, genre
. We want to use this attribute to join the tables corresponding to Author
and Book
, and fetch the result in a DTO. The result should contain the Author
entity and only the title
attribute from Book
. Well, when you are in a scenario as here, it is strongly advisable to avoid fetching the DTO via constructor expression. This approach cannot fetch the data in a single SELECT
, and is prone to N+1. Way better than this consists of using Spring projections, JPA Tuple
or even Hibernate ResultTransformer
. These approaches will fetch the data in a single SELECT
. This application is a DON'T DO THIS example. Check the number of queries needed for fetching the data. In place, do it as here: Entity Inside Spring Projection (no association).
Description: This application is an example of fetching a DTO that includes attributes from an @ElementCollection
.
Key points:
- by default, @ElementCollection
is loaded lazy, keep it lazy
- use a Spring projection and JOIN
in the repository
Description: In case of @ManyToMany
association, we always should rely on Set
(not on List
) for mapping the collection of associated entities (entities of the other parent-side). Why? Well, please see Prefer Set Instead of List in @ManyToMany Relationships. But, is well-known that HashSet
doesn't have a predefined entry order of elements. If this is an issue then this application relies on @OrderBy
which adds an ORDER BY
clause in the SQL statement. The database will handle the ordering. Further, Hibernate will preserve the order via a LinkedHashSet
.
This application uses two entities, Author
and Book
, involved in a lazy bidirectional many-to-many relationship. First, we fetch a Book
by title. Further, we call getAuthors()
to fetch the authors of this book. The fetched authors are ordered descending by name. The ordering is done by the database as a result of adding @OrderBy("name DESC")
, and is preserved by Hibernate.
Key points:
- ask the database to handle ordering and Hibernate to preserve this order via @OrderBy
- this works with HashSet
, but doesn't provide consistency across all transition states (e.g., over transient state)
- for consistency across transient state as well, consider using explicitly LinkedHashSet
instead of HashSet
Note: Alternatively, we can use @OrderColumn
. This gets materialized in an additional column in the junction table. This is needed for maintaining a permanent ordering of the related data.
Description: This is a sample application that shows how versioned (@Version
) optimistic locking and detached entity works. Running the application will result in an optimistic locking specific exception (e.g., the Spring Boot specific, OptimisticLockingFailureException
).
Key points:
- in a transaction, fetch an entity via findById(1L)
; commit transaction and close the persistence context
- in a second transaction, fetch another entity via findById(1L)
and update it; commit the transaction and close the persistence context
- outside transactional context, update the detached entity (fetched in the first transaction)
- in a third transaction, call save()
and pass to it the detached entity; trying to re-attach (EntityManager.merge()
) the entity will end up in an optimistic locking exception since the version of the detached and just loaded entity don't match
Note: Optimistic locking via @Version
works for detached entities as well.
Description: This is a Spring Boot application that simulates a scenario that leads to an optimistic lock exception. So, running the application should end up with a Spring specific ObjectOptimisticLockingFailureException
exception.
Key points:
- set up versioned optimistic locking mechanism
- rely on two concurrent threads that call the same a @Transactional
method used for updating data
Note: Optimistic locking via @Version
works for detached entities as well.
Description: This is a Spring Boot application that simulates a scenario that leads to an optimistic locking exception. When such exception occur, the application retry the corresponding transaction via db-util library developed by Vlad Mihalcea.
Key points:
- in pom.xml
, add the db-util
dependency
- configure the OptimisticConcurrencyControlAspect
bean
- rely on TransactionTemplate
Note: Version-less optimistic locking doesn't work for detached entities (do not close the persistence context).
Description: This is a Spring Boot application that simulates a scenario that leads to an optimistic lock exception. So, running the application should end up with a Spring specific ObjectOptimisticLockingFailureException
exception.
Key points:
- set up version-less optimistic locking mechanism
- rely on two concurrent threads that call the same a @Transactional
method used for updating data
Note: Version-less optimistic locking doesn't work for detached entities (do not close the persistence context).
Description: This is a Spring Boot application that simulates a scenario that leads to an optimistic locking exception. When such exception occur, the application retry the corresponding transaction via db-util library developed by Vlad Mihalcea.
Key points:
- in pom.xml
, add the db-util
dependency
- configure the OptimisticConcurrencyControlAspect
bean
- rely on TransactionTemplate
Description: This is a sample application that shows how to take advantage of versioned optimistic locking and detached entities in HTTP long conversations. The climax consists of storing the detached entities across multiple HTTP requests. Commonly, this can be accomplished via HTTP session.
Key points:
- prepare the entity via @Version
- rely on @SessionAttributes
for storing the detached entities
Sample output (check the message caused by optimistic locking exception):
Note: Rely on this approach only if you simply cannot use JOIN FETCH WHERE
or @NamedEntityGraph
.
Description: This application is a sample of using Hibernate @Where
for filtering associations.
Key points:
- use @Where(clause = "condition to be met")
in entity (check the Author
entity)
Description: Batch inserts (in MySQL) in Spring Boot style.
Key points:
- in application.properties
set spring.jpa.properties.hibernate.jdbc.batch_size
- in application.properties
set spring.jpa.properties.hibernate.generate_statistics
(just to check that batching is working)
- in application.properties
set JDBC URL with rewriteBatchedStatements=true
(optimization for MySQL)
- in application.properties
set JDBC URL with cachePrepStmts=true
(enable caching and is useful if you decide to set prepStmtCacheSize
, prepStmtCacheSqlLimit
, etc as well; without this setting the cache is disabled)
- in application.properties
set JDBC URL with useServerPrepStmts=true
(this way you switch to server-side prepared statements (may lead to signnificant performance boost))
- in case of using a parent-child relationship with cascade persist (e.g. one-to-many, many-to-many) then consider to set up spring.jpa.properties.hibernate.order_inserts=true
to optimize the batching by ordering inserts
- in entity, use the assigned generator since the Hibernate IDENTITY
will cause batching to be disabled
- if is not needed then ensure that Second Level Cache is disabled via spring.jpa.properties.hibernate.cache.use_second_level_cache=false