此 demo 主要演示了 Spring Boot 如何使用 JPA 操作数据库，包含简单使用以及级联使用。
<?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>
<artifactId>spring-boot-demo-orm-jpa</artifactId>
<version>1.0.0-SNAPSHOT</version>
<packaging>jar</packaging>
<name>spring-boot-demo-orm-jpa</name>
<description>Demo project for Spring Boot</description>
<parent>
<groupId>com.xkcoding</groupId>
<artifactId>spring-boot-demo</artifactId>
<version>1.0.0-SNAPSHOT</version>
</parent>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<java.version>1.8</java.version>
</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</artifactId>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>cn.hutool</groupId>
<artifactId>hutool-all</artifactId>
</dependency>
<dependency>
<groupId>com.google.guava</groupId>
<artifactId>guava</artifactId>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
</dependencies>
<build>
<finalName>spring-boot-demo-orm-jpa</finalName>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>/**
* <p>
* JPA配置类
* </p>
*
* @author yangkai.shen
* @date Created in 2018-11-07 11:05
*/
@Configuration
@EnableTransactionManagement
@EnableJpaAuditing
@EnableJpaRepositories(basePackages = "com.xkcoding.orm.jpa.repository", transactionManagerRef = "jpaTransactionManager")
public class JpaConfig {
@Bean
@ConfigurationProperties(prefix = "spring.datasource")
public DataSource dataSource() {
return DataSourceBuilder.create().build();
}
@Bean
public LocalContainerEntityManagerFactoryBean entityManagerFactory() {
HibernateJpaVendorAdapter japVendor = new HibernateJpaVendorAdapter();
japVendor.setGenerateDdl(false);
LocalContainerEntityManagerFactoryBean entityManagerFactory = new LocalContainerEntityManagerFactoryBean();
entityManagerFactory.setDataSource(dataSource());
entityManagerFactory.setJpaVendorAdapter(japVendor);
entityManagerFactory.setPackagesToScan("com.xkcoding.orm.jpa.entity");
return entityManagerFactory;
}
@Bean
public PlatformTransactionManager jpaTransactionManager(EntityManagerFactory entityManagerFactory) {
JpaTransactionManager transactionManager = new JpaTransactionManager();
transactionManager.setEntityManagerFactory(entityManagerFactory);
return transactionManager;
}
}/**
* <p>
* 用户实体类
* </p>
*
* @author yangkai.shen
* @date Created in 2018-11-07 14:06
*/
@EqualsAndHashCode(callSuper = true)
@NoArgsConstructor
@AllArgsConstructor
@Data
@Builder
@Entity
@Table(name = "orm_user")
@ToString(callSuper = true)
public class User extends AbstractAuditModel {
/**
* 用户名
*/
private String name;
/**
* 加密后的密码
*/
private String password;
/**
* 加密使用的盐
*/
private String salt;
/**
* 邮箱
*/
private String email;
/**
* 手机号码
*/
@Column(name = "phone_number")
private String phoneNumber;
/**
* 状态，-1：逻辑删除，0：禁用，1：启用
*/
private Integer status;
/**
* 上次登录时间
*/
@Column(name = "last_login_time")
private Date lastLoginTime;
/**
* 关联部门表
* 1、关系维护端，负责多对多关系的绑定和解除
* 2、@JoinTable注解的name属性指定关联表的名字，joinColumns指定外键的名字，关联到关系维护端(User)
* 3、inverseJoinColumns指定外键的名字，要关联的关系被维护端(Department)
* 4、其实可以不使用@JoinTable注解，默认生成的关联表名称为主表表名+下划线+从表表名，
* 即表名为user_department
* 关联到主表的外键名：主表名+下划线+主表中的主键列名,即user_id,这里使用referencedColumnName指定
* 关联到从表的外键名：主表中用于关联的属性名+下划线+从表的主键列名,department_id
* 主表就是关系维护端对应的表，从表就是关系被维护端对应的表
*/
@ManyToMany(cascade = CascadeType.ALL, fetch = FetchType.EAGER)
@JoinTable(name = "orm_user_dept", joinColumns = @JoinColumn(name = "user_id", referencedColumnName = "id"), inverseJoinColumns = @JoinColumn(name = "dept_id", referencedColumnName = "id"))
private Collection<Department> departmentList;
}/**
* <p>
* 部门实体类
* </p>
*
* @author 76peter
* @date Created in 2019-10-01 18:07
*/
@EqualsAndHashCode(callSuper = true)
@Data
@NoArgsConstructor
@AllArgsConstructor
@Builder
@Entity
@Table(name = "orm_department")
@ToString(callSuper = true)
public class Department extends AbstractAuditModel {
/**
* 部门名
*/
@Column(name = "name", columnDefinition = "varchar(255) not null")
private String name;
/**
* 上级部门id
*/
@ManyToOne(cascade = {CascadeType.REFRESH}, optional = true)
@JoinColumn(name = "superior", referencedColumnName = "id")
private Department superior;
/**
* 所属层级
*/
@Column(name = "levels", columnDefinition = "int not null default 0")
private Integer levels;
/**
* 排序
*/
@Column(name = "order_no", columnDefinition = "int not null default 0")
private Integer orderNo;
/**
* 子部门集合
*/
@OneToMany(cascade = {CascadeType.REFRESH, CascadeType.REMOVE}, fetch = FetchType.EAGER, mappedBy = "superior")
private Collection<Department> children;
/**
* 部门下用户集合
*/
@ManyToMany(mappedBy = "departmentList")
private Collection<User> userList;
}/**
* <p>
* 实体通用父类
* </p>
*
* @author yangkai.shen
* @date Created in 2018-11-07 14:01
*/
@MappedSuperclass
@EntityListeners(AuditingEntityListener.class)
@Data
public abstract class AbstractAuditModel implements Serializable {
/**
* 主键
*/
@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
private Long id;
/**
* 创建时间
*/
@Temporal(TemporalType.TIMESTAMP)
@Column(name = "create_time", nullable = false, updatable = false)
@CreatedDate
private Date createTime;
/**
* 上次更新时间
*/
@Temporal(TemporalType.TIMESTAMP)
@Column(name = "last_update_time", nullable = false)
@LastModifiedDate
private Date lastUpdateTime;
}/**
* <p>
* User Dao
* </p>
*
* @author yangkai.shen
* @date Created in 2018-11-07 14:07
*/
@Repository
public interface UserDao extends JpaRepository<User, Long> {
}/**
* <p>
* User Dao
* </p>
*
* @author 76peter
* @date Created in 2019-10-01 18:07
*/
@Repository
public interface DepartmentDao extends JpaRepository<Department, Long> {
/**
* 根据层级查询部门
*
* @param level 层级
* @return 部门列表
*/
List<Department> findDepartmentsByLevels(Integer level);
}server:
port: 8080
servlet:
context-path: /demo
spring:
datasource:
jdbc-url: jdbc:mysql://127.0.0.1:3306/spring-boot-demo?useUnicode=true&characterEncoding=UTF-8&useSSL=false&autoReconnect=true&failOverReadOnly=false&serverTimezone=GMT%2B8
username: root
password: root
driver-class-name: com.mysql.cj.jdbc.Driver
type: com.zaxxer.hikari.HikariDataSource
initialization-mode: always
continue-on-error: true
schema:
- "classpath:db/schema.sql"
data:
- "classpath:db/data.sql"
hikari:
minimum-idle: 5
connection-test-query: SELECT 1 FROM DUAL
maximum-pool-size: 20
auto-commit: true
idle-timeout: 30000
pool-name: SpringBootDemoHikariCP
max-lifetime: 60000
connection-timeout: 30000
jpa:
show-sql: true
hibernate:
ddl-auto: validate
properties:
hibernate:
dialect: org.hibernate.dialect.MySQL57InnoDBDialect
open-in-view: true
logging:
level:
com.xkcoding: debug
org.hibernate.SQL: debug
org.hibernate.type: trace/**
* <p>
* jpa 测试类
* </p>
*
* @author yangkai.shen
* @date Created in 2018-11-07 14:09
*/
@Slf4j
public class UserDaoTest extends SpringBootDemoOrmJpaApplicationTests {
@Autowired
private UserDao userDao;
/**
* 测试保存
*/
@Test
public void testSave() {
String salt = IdUtil.fastSimpleUUID();
User testSave3 = User.builder().name("testSave3").password(SecureUtil.md5("123456" + salt)).salt(salt).email("testSave3@xkcoding.com").phoneNumber("17300000003").status(1).lastLoginTime(new DateTime()).build();
userDao.save(testSave3);
Assert.assertNotNull(testSave3.getId());
Optional<User> byId = userDao.findById(testSave3.getId());
Assert.assertTrue(byId.isPresent());
log.debug("【byId】= {}", byId.get());
}
/**
* 测试删除
*/
@Test
public void testDelete() {
long count = userDao.count();
userDao.deleteById(1L);
long left = userDao.count();
Assert.assertEquals(count - 1, left);
}
/**
* 测试修改
*/
@Test
public void testUpdate() {
userDao.findById(1L).ifPresent(user -> {
user.setName("JPA修改名字");
userDao.save(user);
});
Assert.assertEquals("JPA修改名字", userDao.findById(1L).get().getName());
}
/**
* 测试查询单个
*/
@Test
public void testQueryOne() {
Optional<User> byId = userDao.findById(1L);
Assert.assertTrue(byId.isPresent());
log.debug("【byId】= {}", byId.get());
}
/**
* 测试查询所有
*/
@Test
public void testQueryAll() {
List<User> users = userDao.findAll();
Assert.assertNotEquals(0, users.size());
log.debug("【users】= {}", users);
}
/**
* 测试分页排序查询
*/
@Test
public void testQueryPage() {
// 初始化数据
initData();
// JPA分页的时候起始页是页码减1
Integer currentPage = 0;
Integer pageSize = 5;
Sort sort = Sort.by(Sort.Direction.DESC, "id");
PageRequest pageRequest = PageRequest.of(currentPage, pageSize, sort);
Page<User> userPage = userDao.findAll(pageRequest);
Assert.assertEquals(5, userPage.getSize());
Assert.assertEquals(userDao.count(), userPage.getTotalElements());
log.debug("【id】= {}", userPage.getContent().stream().map(User::getId).collect(Collectors.toList()));
}
/**
* 初始化10条数据
*/
private void initData() {
List<User> userList = Lists.newArrayList();
for (int i = 0; i < 10; i++) {
String salt = IdUtil.fastSimpleUUID();
int index = 3 + i;
User user = User.builder().name("testSave" + index).password(SecureUtil.md5("123456" + salt)).salt(salt).email("testSave" + index + "@xkcoding.com").phoneNumber("1730000000" + index).status(1).lastLoginTime(new DateTime()).build();
userList.add(user);
}
userDao.saveAll(userList);
}
}/**
* <p>
* jpa 测试类
* </p>
*
* @author 76peter
* @date Created in 2018-11-07 14:09
*/
@Slf4j
public class DepartmentDaoTest extends SpringBootDemoOrmJpaApplicationTests {
@Autowired
private DepartmentDao departmentDao;
@Autowired
private UserDao userDao;
/**
* 测试保存 ,根节点
*/
@Test
@Transactional
public void testSave() {
Collection<Department> departmentList = departmentDao.findDepartmentsByLevels(0);
if (departmentList.size() == 0) {
Department testSave1 = Department.builder().name("testSave1").orderNo(0).levels(0).superior(null).build();
Department testSave1_1 = Department.builder().name("testSave1_1").orderNo(0).levels(1).superior(testSave1).build();
Department testSave1_2 = Department.builder().name("testSave1_2").orderNo(0).levels(1).superior(testSave1).build();
Department testSave1_1_1 = Department.builder().name("testSave1_1_1").orderNo(0).levels(2).superior(testSave1_1).build();
departmentList.add(testSave1);
departmentList.add(testSave1_1);
departmentList.add(testSave1_2);
departmentList.add(testSave1_1_1);
departmentDao.saveAll(departmentList);
Collection<Department> deptall = departmentDao.findAll();
log.debug("【部门】= {}", JSONArray.toJSONString((List) deptall));
}
userDao.findById(1L).ifPresent(user -> {
user.setName("添加部门");
Department dept = departmentDao.findById(2L).get();
user.setDepartmentList(departmentList);
userDao.save(user);
});
log.debug("用户部门={}", JSONUtil.toJsonStr(userDao.findById(1L).get().getDepartmentList()));
departmentDao.findById(2L).ifPresent(dept -> {
Collection<User> userlist = dept.getUserList();
//关联关系由user维护中间表，department userlist不会发生变化，可以增加查询方法来处理 重写getUserList方法
log.debug("部门下用户={}", JSONUtil.toJsonStr(userlist));
});
userDao.findById(1L).ifPresent(user -> {
user.setName("清空部门");
user.setDepartmentList(null);
userDao.save(user);
});
log.debug("用户部门={}", userDao.findById(1L).get().getDepartmentList());
}
}- Spring Data JPA 官方文档：https://docs.spring.io/spring-data/jpa/docs/current/reference/html/