Spring Data JPA Batch Insertion
转自:https://www.jeejava.com/spring-data-jpa-batch-insertion/
Spring Data JPA Batch Insertion will show you how we can insert a large dataset into a database at once using Spring Data JPA. For this tutorial we will create a Spring Boot project in Eclipse. We will also see how Spring @Transactional annotation works. Spring transaction required in order to rollback the inserted data at any point if your application fails for any reason.
Sometimes we need to insert or update large number of records in the database. It’s not a good idea to insert multiple records into database one by one in a traditional approach. It will hit the application’s performance. Spring provides batch operations with the help of JpaRepository or CrudRepository, it inserts or updates records into database in one shot. You can also use JDBC API to insert multiple records or batch insertion into database but here we will use Spring JPA’s built-in functionality to get benefits of Spring API.
By default Spring does not save your data into database when you call save() method with multiple entities (a list of objects) passed as argument, hence you have to save entities one by one, which is time consuming and performance gets affected. For this there are few properties that need to be configured to let Spring Data JPA work on batch insertion into database. We will see how these properties set during creation of database configuration class below.
You may also like to read:
Batch Insert using Spring JdbcTemplate
Transaction Management in Spring
Hibernate UserType using Spring Data JPA
Spring EnableEncryptableProperties with Jasypt
Spring Data JPA Entity Auditing using EntityListeners
Prerequisites
The following configurations are required in order to run the application
Eclipse
JDK 1.8
Have gradle installed and configured
Spring dependencies in build.gradle script
Now we will see the below steps how to create a gradle based spring project in Eclipse to work on example Spring Data JPA Batch Insertion.
Creating and setting up the project
First you need to setup the gradle based project in Eclipse and we have to make sure using the below build script we will be able to build the blank project.
In this file notice we have applied required plugins and added required dependencies, such as spring-boot-starter-web, spring-boot-starter-data-jpa and oracle jdbc driver to interact with Java and database API.
Once you create below file, please try to build the project, you should be able to build the blank project.
buildscript {
ext {
springBootVersion = '1.5.9.RELEASE'
}
repositories {
mavenLocal()
mavenCentral()
}
dependencies {
classpath("org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}")
}
} apply plugin: 'java'
apply plugin: 'org.springframework.boot' sourceCompatibility = 1.8
targetCompatibility = 1.8 repositories {
mavenLocal()
mavenCentral()
} dependencies {
compile('org.springframework.boot:spring-boot-starter-web')
compile("org.springframework.boot:spring-boot-starter-data-jpa")
runtime("com.oracle.jdbc:ojdbc7:12.1.0.2")
}
Creating application.properties file under classpath
Below is the application.properties file under classpath directory src/main/resources and you need to define database credentials to establish connection with database.
Also if you do not want server to run on default port then you may want to specify the server port using server.port key.
Here in Spring Data JPA Batch Insertion example, I am going to use Oracle database but you may use any database as per your requirements.
#datasource
spring.datasource.driverClassName=oracle.jdbc.driver.OracleDriver
spring.datasource.hibernate.dialect=org.hibernate.dialect.Oracle12cDialect
spring.datasource.url=jdbc:Oracle:thin:@//<host>:<port>/<service name>
spring.datasource.username=<username>
spring.datasource.password=<password> server.port=9999 #disable schema generation from Hibernate
spring.jpa.hibernate.ddl-auto=none
Creating database configuration class
Below is the configuration class that will be used to define various database related beans such as DataSource, EntityManagerFactory etc.
As we know JPA is a specification or Interface and someone has to provide its own implementation, so here we are using Hibernate as an implementation of JPA API.
As we have application.properties file in classpath, so we don’t need to load the properties file.
We have let Spring know where our Spring Data JPA Repository interfaces using the annotation @EnableJpaRepositories and we have also let Spring know where to look for Entity classes using the setter method factory.setPackagesToScan(“com.jeejava.entity”).
By default Spring does not work when you want to insert multiple records or entities using save() method of JpaRepository or CrudRepository and that’s why you need to set few properties into
LocalContainerEntityManagerFactoryBean as shown below in entityManagerFactory() method. You can change the batch size, here I have put 500.
By default Spring transaction works out of the box so you may not need to annotate the configuration class with @EnableTransactionManagement.
package com.jeejava.config; import javax.persistence.EntityManagerFactory;
import javax.sql.DataSource;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.env.Environment;
import org.springframework.data.jpa.repository.config.EnableJpaRepositories;
import org.springframework.jdbc.datasource.DriverManagerDataSource;
import org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean;
import org.springframework.orm.jpa.vendor.Database;
import org.springframework.orm.jpa.vendor.HibernateJpaVendorAdapter; @Configuration
@EnableJpaRepositories(basePackages = "com.jeejava.repository")
public class DatabaseConfig { @Autowired
private Environment environment; @Bean
public DataSource dataSource() {
DriverManagerDataSource ds = new DriverManagerDataSource();
ds.setDriverClassName(environment.getRequiredProperty("spring.datasource.driverClassName"));
ds.setUrl(environment.getRequiredProperty("spring.datasource.url"));
ds.setUsername(environment.getRequiredProperty("spring.datasource.username"));
ds.setPassword(environment.getRequiredProperty("spring.datasource.password"));
return ds;
} @Bean
public EntityManagerFactory entityManagerFactory(DataSource dataSource) {
HibernateJpaVendorAdapter vendorAdapter = new HibernateJpaVendorAdapter();
vendorAdapter.setDatabase(Database.ORACLE);
LocalContainerEntityManagerFactoryBean factory = new LocalContainerEntityManagerFactoryBean(); //Use these properties to let spring work on batch insertion
Properties jpaProperties = new Properties();
jpaProperties.put("hibernate.jdbc.batch_size", 500);
jpaProperties.put("hibernate.order_inserts", true);
jpaProperties.put("hibernate.order_updates", true);
lemfb.setJpaProperties(jpaProperties); factory.setJpaVendorAdapter(vendorAdapter);
factory.setPackagesToScan("com.jeejava.entity");
factory.setDataSource(dataSource);
factory.afterPropertiesSet();
return factory.getObject();
}
}
Creating entity class
This is the entity class that maps Java object to database table. This entity class represents a single row in database table. When you want to save multiple rows in database table then you pass a list of entity objects to JpaRepository or CrudRepository’s save() method in order to save multiple entities or objects and this basically happens through Spring Data JPA Batch Insertion configuration. We also save single object using the same save() method.
package com.jeejava.entity; import java.io.Serializable;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.Id;
import javax.persistence.Table; @Entity
@Table(name = "EMPLOYEE")
public class Employee implements Serializable { private static final long serialVersionUID = 1L; @Id
@Column(name = "EMPLOYEE_ID")
private Integer empId; @Column(name = "EMPLOYEE_NAME")
private String empName;
//getters and setters
}
Spring Data JPA Repository
Here is the Spring Data JPA Repository interface. Here JpaRepository takes two parameters Employee object, i.e., entity object and primary key, i.e., Integer. You may have Long, String or any other class object as a primary key as well.
package com.jeejava.repository; import org.springframework.data.jpa.repository.JpaRepository;
import com.jeejava.entity.Employee; public interface EmployeeRepository extends JpaRepository<Employee, Integer> {
}
Creating Service class
This is the service class that interacts with data layer as well as controller layer and acts as a mediator between them. This class generally handles all business logic.
In this service we will see the example on Spring Data JPA Batch Insertion. Here notice how I am determining when to insert into database.
Here we iterate through list of employee objects and add to temporary Employee array list. Once we find counter equals to batch size(500) then we save those entity objects and at the same time we also clear the temp list because we don’t need those records in temp list any more.
Notice we have used @Transactional annotation in order to support Spring’s transaction management to rollback database insertion at any point of failures.
package com.jeejava.service; import java.util.List;
import javax.annotation.Resource;
import org.springframework.stereotype.Service;
import com.jeejava.entity.Employee;
import com.jeejava.repository.EmployeeRepository; @Service
public class EmployeeService {
@Resource
private EmployeeRepository employeeRepository;
@Transactional
public void saveEmployees(List<Employee> employees) {
int size = employees.size();
int counter = 0; List<Employee> temp = new ArrayList<>(); for (Employee emp : employees) {
temp.add(emp); if ((counter + 1) % 500 == 0 || (counter + 1) == size) {
employeeRepository.save(temp);
temp.clear();
}
counter++;
}
}
}
Spring REST Controller
The Spring REST Controller class is resposible for handling requests and responses from clients. This holds all the REST services end-points. Using these end-points we would be able to get the JSON response.
Here we have only one end-point called /employees/save that saves a list of employees into database when you hit the URL http://localhost:9999/employees/save from REST client or Postman with a list of employee objects in JSON format as a body parameter.
package com.jeejava.controller; import java.util.List;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
import com.jeejava.entity.Employee;
import com.jeejava.service.EmployeeService; @RestController
public class EmployeeRestController { @Autowired
private EmployeeService employeeService; @PostMapping("/employees/save")
public ResponseEntity<Void> saveEmployees(@RequestBody List<Employee> employees) {
employeeService.saveEmployees(employees);
return new ResponseEntity<Void>(HttpStatus.OK);
}
}
Here is the application main class that is enough to start up the application in Spring Boot.
package com.jeejava.application; import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication; @SpringBootApplication(scanBasePackages = "com.jeejava")
public class Application { public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}
Once you run the above main class and application gets start up, hit the URL http://localhost:9999/employees/save from REST client or Postman with list of employee objects as json and you should get the JSON response with OK.
You may also like to read:
Batch Insert using Spring JdbcTemplate
Transaction Management in Spring
Hibernate UserType using Spring Data JPA
Spring EnableEncryptableProperties with Jasypt
Spring Data JPA Entity Auditing using EntityListeners
That’s all. Hope you found idea on Spring Data JPA Batch Insertion.
Thanks for reading.
Spring Data JPA Batch Insertion的更多相关文章
- spring data jpa开启批量插入、批量更新
spring data jpa开启批量插入.批量更新 原文链接:https://www.cnblogs.com/blog5277/p/10661096.html 原文作者:博客园--曲高终和寡 *** ...
- Spring Boot:整合Spring Data JPA
综合概述 JPA是Java Persistence API的简称,是一套Sun官方提出的Java持久化规范.其设计目标主要是为了简化现有的持久化开发工作和整合ORM技术,它为Java开发人员提供了一种 ...
- 快速搭建springmvc+spring data jpa工程
一.前言 这里简单讲述一下如何快速使用springmvc和spring data jpa搭建后台开发工程,并提供了一个简单的demo作为参考. 二.创建maven工程 http://www.cnblo ...
- spring boot(五):spring data jpa的使用
在上篇文章springboot(二):web综合开发中简单介绍了一下spring data jpa的基础性使用,这篇文章将更加全面的介绍spring data jpa 常见用法以及注意事项 使用spr ...
- 转:使用 Spring Data JPA 简化 JPA 开发
从一个简单的 JPA 示例开始 本文主要讲述 Spring Data JPA,但是为了不至于给 JPA 和 Spring 的初学者造成较大的学习曲线,我们首先从 JPA 开始,简单介绍一个 JPA 示 ...
- 深入浅出学Spring Data JPA
第一章:Spring Data JPA入门 Spring Data是什么 Spring Data是一个用于简化数据库访问,并支持云服务的开源框架.其主要目标是使得对数据的访问变得方便快捷,并支持map ...
- spring data jpa 调用存储过程
网上这方面的例子不是很多,研究了一下,列出几个调用的方法. 假如我们有一个mysql的存储过程 CREATE DEFINER=`root`@`localhost` PROCEDURE `plus1in ...
- Spring Data JPA 学习记录1 -- 单向1:N关联的一些问题
开新坑 开新坑了(笑)....公司项目使用的是Spring Data JPA做持久化框架....学习了一段时间以后发现了一点值得注意的小问题.....与大家分享 主要是针对1:N单向关联产生的一系列问 ...
- Spring Boot with Spring Data JPA (1) - Concept
What's Spring Data JPA? According to Pivotal, Spring Data JPA, part of the larger Spring Data family ...
随机推荐
- vue实现双向数据绑定之Object.defineProperty()篇
前言 vue.js中使用ES5的Object.defineProperty()实现数据的双向绑定 Object.defineProperty()原理 Object.defineProperty()可以 ...
- vue的地图插件amap
https://www.jianshu.com/p/0011996b81e2(amap) npm install vue-amap --save
- 判断String类型字符串是否为空的方法
在项目中经常遇到要判断String类型的字段是否为空操作 我们可以用Apache提供的StringUtils这个工具类,不用自己去判断,也不用自己封装判断空的方法 它有两个版本,一个是org.apac ...
- 转《在浏览器中使用tensorflow.js进行人脸识别的JavaScript API》
作者 | Vincent Mühle 编译 | 姗姗 出品 | 人工智能头条(公众号ID:AI_Thinker) [导读]随着深度学习方法的应用,浏览器调用人脸识别技术已经得到了更广泛的应用与提升.在 ...
- Socket构造但不连接
Socket socket = new Socket(); SocketAddress address = new InetSocketAddress("localhost",80 ...
- DNS 到底怎么工作的? (How does dns work?)
其实这个问题每次看的时候都觉得很明白,但是很久之后就忘记了,所以这次准备记录下来.深入到这个过程的各个细节之中,以后多看看. Step 1 请求缓存信息: 当你在开始访问一个 www.baidu.co ...
- APP测试重点(转载)
1.安装卸载测试: app在不同的操作系统(安卓和ios),不同的版本,不同的机型上是否都能安装成功: 在安装过程中,突然断网或网络不好,是否给出有好的提示,网络恢复之后是否能正常下载: 在安装过 ...
- Delphi之TComponent类
TComponent类 TComponent类直接由TPersistent派生.TComponent的独特特征是它的属性能够在设计期间通过ObjectInspector来控制,能够拥有其他组件.非可视 ...
- 表单中input name属性有无[]的区别
1 input数组 如下一个表单: <input type="text" name="username[]" value="Jason" ...
- easyui combobox 在datagrid中动态加载数据
场景:datagrid 中用编辑框修改数据,有一个列使用的combobox 在可编辑的时候需要动态绑定数据,这个数据是在根据其他条件可变的 思路:在每次开启编辑框的时候动态绑定数据, datagri ...