Batch inserts in Spring style and batch per transaction

Author: AnghelLeonard

HibernateSpringBootBatchInsertsSpringStyleBatchPerTransaction/README.md

@@ -0,0 +1,22 @@
+
+**[Batch Inserts In Spring Boot Style](https://github.com/AnghelLeonard/Hibernate-SpringBoot/tree/master/HibernateSpringBootBatchInsertsSpringStyle)**
+
+**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](https://vladmihalcea.com/how-to-combine-the-hibernate-assigned-generator-with-a-sequence-or-an-identity-column/) since the Hibernate `IDENTITY` will cause insert 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`
+   
+**Output example:**
+![](https://github.com/AnghelLeonard/Hibernate-SpringBoot/blob/master/HibernateSpringBootBatchInsertsSpringStyle/batch%20inserts%20in%20spring%20boot%20style.png)
+     
+-------------------------------
+
+**You may like to try as well:**
+<a href="https://leanpub.com/java-persistence-performance-illustrated-guide"><p align="center"><img src="https://github.com/AnghelLeonard/Hibernate-SpringBoot/blob/master/Java%20Persistence%20Performance%20Illustrated%20Guide.jpg" height="410" width="350"/></p></a>

HibernateSpringBootBatchInsertsSpringStyleBatchPerTransaction/batch inserts in spring boot style.png

@@ -0,0 +1,62 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <groupId>com.jpa</groupId>
+    <artifactId>HibernateSpringBootBatchInsertsSpringStyleBatchPerTransaction</artifactId>
+    <version>1.0</version>
+    <packaging>jar</packaging>
+
+    <name>HibernateSpringBootBatchInsertsSpringStyleBatchPerTransaction</name>
+    <description>JPA project for Spring Boot</description>
+
+    <parent>
+        <groupId>org.springframework.boot</groupId>
+        <artifactId>spring-boot-starter-parent</artifactId>
+        <version>2.1.4.RELEASE</version>
+        <relativePath/> <!-- lookup parent from repository -->
+    </parent>
+
+    <properties>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
+        <java.version>1.8</java.version>
+        <maven.compiler.source>12</maven.compiler.source>
+        <maven.compiler.target>12</maven.compiler.target>
+    </properties>
+
+    <dependencies>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-data-jpa</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-jdbc</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-web</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>mysql</groupId>
+            <artifactId>mysql-connector-java</artifactId>
+            <scope>runtime</scope>
+        </dependency>        
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-test</artifactId>
+            <scope>test</scope>
+        </dependency>
+    </dependencies>
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.springframework.boot</groupId>
+                <artifactId>spring-boot-maven-plugin</artifactId>
+            </plugin>
+        </plugins>
+    </build>
+</project>

HibernateSpringBootBatchInsertsSpringStyleBatchPerTransaction/pom.xml

@@ -0,0 +1,31 @@
+package com.bookstore;
+
+import com.bookstore.impl.BatchRepositoryImpl;
+import com.bookstore.service.BookstoreService;
+import org.springframework.boot.ApplicationRunner;
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.context.annotation.Bean;
+import org.springframework.data.jpa.repository.config.EnableJpaRepositories;
+
+@SpringBootApplication
+@EnableJpaRepositories(repositoryBaseClass = BatchRepositoryImpl.class)
+public class MainApplication {
+
+    private final BookstoreService bookstoreService;
+
+    public MainApplication(BookstoreService bookstoreService) {
+        this.bookstoreService = bookstoreService;
+    }
+
+    public static void main(String[] args) {
+        SpringApplication.run(MainApplication.class, args);
+    }
+
+    @Bean
+    public ApplicationRunner init() {
+        return args -> {
+            bookstoreService.batchAuthors();
+        };
+    }
+}

HibernateSpringBootBatchInsertsSpringStyleBatchPerTransaction/src/main/java/com/bookstore/MainApplication.java

@@ -0,0 +1,51 @@
+package com.bookstore.entity;
+
+import java.io.Serializable;
+import javax.persistence.Entity;
+import javax.persistence.Id;
+
+@Entity
+public class Author implements Serializable {
+
+    private static final long serialVersionUID = 1L;
+
+    @Id    
+    private Long id;
+
+    private String name;
+    private String genre;
+    private int age;
+
+    public Long getId() {
+        return id;
+    }
+
+    public void setId(Long id) {
+        this.id = id;
+    }
+
+    public String getName() {
+        return name;
+    }
+
+    public void setName(String name) {
+        this.name = name;
+    }
+
+    public String getGenre() {
+        return genre;
+    }
+
+    public void setGenre(String genre) {
+        this.genre = genre;
+    }    
+
+    public int getAge() {
+        return age;
+    }
+
+    public void setAge(int age) {
+        this.age = age;
+    }
+
+}

HibernateSpringBootBatchInsertsSpringStyleBatchPerTransaction/src/main/java/com/bookstore/entity/Author.java

@@ -0,0 +1,67 @@
+package com.bookstore.impl;
+
+import java.util.logging.Level;
+import java.util.logging.Logger;
+import javax.persistence.EntityManager;
+import javax.persistence.EntityManagerFactory;
+import javax.persistence.EntityTransaction;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.stereotype.Component;
+
+@Component
+public class BatchExecutor<T> {
+
+    private static final Logger logger = Logger.getLogger(BatchExecutor.class.getName());
+
+    @Value("${spring.jpa.properties.hibernate.jdbc.batch_size}")
+    private int batchSize;
+
+    private final EntityManagerFactory entityManagerFactory;
+
+    public BatchExecutor(EntityManagerFactory entityManagerFactory) {
+        this.entityManagerFactory = entityManagerFactory;
+    }
+
+    public <S extends T> void saveInBatch(Iterable<S> entities) {
+
+        if (entities == null) {
+            throw new IllegalArgumentException("The given Iterable of entities not be null!");
+        }
+
+        EntityManager entityManager = entityManagerFactory.createEntityManager();
+        EntityTransaction entityTransaction = entityManager.getTransaction();
+
+        try {
+            entityTransaction.begin();
+
+            int i = 0;
+            for (S entity : entities) {
+                if (i % batchSize == 0 && i > 0) {
+                    logger.log(Level.INFO,
+                            "Flushing the EntityManager containing {0} entities ...", batchSize);
+
+                    entityTransaction.commit();
+                    entityTransaction.begin();
+
+                    entityManager.clear();
+                }
+
+                entityManager.persist(entity);
+                i++;
+            }
+
+            logger.log(Level.INFO,
+                    "Flushing the remaining entities ...");
+
+            entityTransaction.commit();
+        } catch (RuntimeException e) {
+            if (entityTransaction.isActive()) {
+                entityTransaction.rollback();
+            }
+
+            throw e;
+        } finally {
+            entityManager.close();
+        }
+    }
+}

HibernateSpringBootBatchInsertsSpringStyleBatchPerTransaction/src/main/java/com/bookstore/impl/BatchExecutor.java

@@ -0,0 +1,11 @@
+package com.bookstore.impl;
+
+import java.io.Serializable;
+import org.springframework.data.jpa.repository.JpaRepository;
+import org.springframework.data.repository.NoRepositoryBean;
+
+@NoRepositoryBean
+public interface BatchRepository<T, ID extends Serializable> extends JpaRepository<T, ID> {
+
+    <S extends T> void saveInBatch(Iterable<S> entites);
+}

HibernateSpringBootBatchInsertsSpringStyleBatchPerTransaction/src/main/java/com/bookstore/impl/BatchRepository.java

@@ -0,0 +1,35 @@
+package com.bookstore.impl;
+
+import java.io.Serializable;
+import java.util.logging.Logger;
+import javax.persistence.EntityManager;
+import org.springframework.data.jpa.repository.support.JpaEntityInformation;
+import org.springframework.data.jpa.repository.support.SimpleJpaRepository;
+import org.springframework.transaction.annotation.Transactional;
+
+@Transactional(readOnly = true)
+public class BatchRepositoryImpl<T, ID extends Serializable>
+        extends SimpleJpaRepository<T, ID> implements BatchRepository<T, ID> {
+
+    private static final Logger logger = Logger.getLogger(BatchRepositoryImpl.class.getName());
+
+    private final EntityManager entityManager;
+
+    public BatchRepositoryImpl(JpaEntityInformation entityInformation,
+            EntityManager entityManager) {
+        super(entityInformation, entityManager);
+
+        this.entityManager = entityManager;
+    }
+
+    @Override
+    public <S extends T> void saveInBatch(Iterable<S> entities) {
+
+        if (entities == null) {
+            throw new IllegalArgumentException("The given Iterable of entities cannot be null!");
+        }
+
+        BatchExecutor batchExecutor = SpringContext.getBean(BatchExecutor.class);
+        batchExecutor.saveInBatch(entities);
+    }
+}

HibernateSpringBootBatchInsertsSpringStyleBatchPerTransaction/src/main/java/com/bookstore/impl/BatchRepositoryImpl.java

@@ -0,0 +1,21 @@
+package com.bookstore.impl;
+
+import org.springframework.beans.BeansException;
+import org.springframework.context.ApplicationContext;
+import org.springframework.context.ApplicationContextAware;
+import org.springframework.stereotype.Component;
+
+@Component
+public class SpringContext implements ApplicationContextAware {
+     
+    private static ApplicationContext context;
+     
+    public static <T extends Object> T getBean(Class<T> beanClass) {
+        return context.getBean(beanClass);
+    }
+     
+    @Override
+    public void setApplicationContext(ApplicationContext context) throws BeansException {         
+        SpringContext.context = context;
+    }
+}

HibernateSpringBootBatchInsertsSpringStyleBatchPerTransaction/src/main/java/com/bookstore/impl/SpringContext.java

@@ -0,0 +1,10 @@
+package com.bookstore.repository;
+
+import com.bookstore.impl.BatchRepository;
+import com.bookstore.entity.Author;
+import org.springframework.stereotype.Repository;
+
+@Repository
+public interface AuthorRepository extends BatchRepository<Author, Long> {        
+}
+

HibernateSpringBootBatchInsertsSpringStyleBatchPerTransaction/src/main/java/com/bookstore/repository/AuthorRepository.java

@@ -0,0 +1,34 @@
+package com.bookstore.service;
+
+import java.util.ArrayList;
+import java.util.List;
+import com.bookstore.entity.Author;
+import com.bookstore.repository.AuthorRepository;
+import org.springframework.stereotype.Service;
+
+@Service
+public class BookstoreService {
+
+    private final AuthorRepository authorRepository;
+
+    public BookstoreService(AuthorRepository authorRepository) {
+        this.authorRepository = authorRepository;
+    }
+
+    public void batchAuthors() {
+
+        List<Author> authors = new ArrayList<>();
+
+        for (int i = 0; i < 1000; i++) {
+            Author author = new Author();
+            author.setId((long) i + 1);
+            author.setName("Name_" + i);
+            author.setGenre("Genre_" + i);
+            author.setAge(18 + i);
+
+            authors.add(author);
+        }
+
+        authorRepository.saveInBatch(authors);
+    }
+}

HibernateSpringBootBatchInsertsSpringStyleBatchPerTransaction/src/main/java/com/bookstore/service/BookstoreService.java

@@ -0,0 +1,19 @@
+spring.datasource.url=jdbc:mysql://localhost:3306/bookstoredb?cachePrepStmts=true&useServerPrepStmts=true&rewriteBatchedStatements=true&createDatabaseIfNotExist=true
+spring.datasource.username=root
+spring.datasource.password=root
+
+spring.jpa.hibernate.ddl-auto=create
+spring.jpa.show-sql=true
+
+spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.MySQL5Dialect
+
+spring.jpa.open-in-view=false
+
+spring.jpa.properties.hibernate.jdbc.batch_size=30
+
+spring.jpa.properties.hibernate.cache.use_second_level_cache=false
+
+# this is needed for ordering inserts in case of relationships
+# spring.jpa.properties.hibernate.order_inserts=true
+
+spring.jpa.properties.hibernate.generate_statistics=true