Spring Data JPA使用必备(一):Spring Data JPA整合Spring以及简单的使用

最近公司部分新开的项目需要使用Spring data JPA技术,作为一个从来没有用过JPA的小白来说,需要重新的学习。N年前简单的看过JPA,这么多年没用过,完全忘记了有木有。接下来的系列文章就一起来整理一下。

本次的spring data jpa系列文章都是以spring boot整合为基础的。

Spring data JPA和Spring boot整合

Spring data JPA的介绍不说了,网上的说明很多,建议可以看一下程序员DD关于JPA的文章:Spring Boot中使用Spring-data-jpa让数据访问更简单、更优雅(为什么不直接转载,毕竟自己写出来的印象才会最深刻)。在整个篇幅中,也有很多内容是借鉴这篇文章的。

引入的依赖

和Spring boot整合后的依赖很简单。⬇️

1
2
3
4
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-jpa</artifactId>
</dependency>

这里没有指定版本号,用过Spring boot的都知道,在引入parent(spring-boot-starter-parent)依赖的时候已经指定了版本号,后续再引入spring boot下的依赖就不需要指定版本号啦。

数据库配置

这里写的配置就是最简单的连接方式,其他的细节配置不是本系列博客的讨论点,就不多说了。

1
2
3
4
spring.datasource.url=jdbc:mysql://localhost:3306/test
spring.datasource.username=root
spring.datasource.password=root
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
Spring data JPA配置

JPA的配置是比较多的,但是大部分保持默认即可,主要的见下面的配置列表:

1
2
3
4
5
spring.jpa.database = MYSQL #指定数据库的类型
spring.jpa.show-sql = false #是否输出SQL
spring.jpa.properties.hibernate.hbm2ddl.auto = false
spring.jpa.properties.hibernate.format_sql = true #是否格式化SQL语句
spring.jpa.properties.hibernate.dialect = org.hibernate.dialect.MySQL5Dialect #指定方言

其中spring.jpa.properties.hibernate.hbm2ddl.auto是Hibernate的的相关配置,主要作用是:自动创建、更新、验证数据库表结构。该参数的几种配置如下:

  • create:每次加载hibernate时都会删除上一次生成的表,然后根据你的model类再重新来生成新表,哪怕两次没有任何改变也要这样执行,这就是导致数据库表数据丢失的一个重要原因。
  • create-drop:每次加载hibernate时根据model类生成表,但是sessionFactory一关闭,表就自动删除。
  • update:最常用的属性,第一次加载hibernate时根据model类会自动建立起表的结构(前提是先建立好数据库),以后加载hibernate时根据model类自动更新表结构,即使表结构改变了但表中的行仍然存在不会删除以前的行。要注意的是当部署到服务器后,表结构是不会被马上建立起来的,是要等应用第一次运行起来后才会。
  • validate:每次加载hibernate时,验证创建数据库表结构,只会和数据库中的表进行比较,不会创建新表,但是会插入新值。

在这里spring.jpa.properties.hibernate.hbm2ddl.auto使用的值是false,一开始使用的create-drop,但是每次运行都查不到结果,并且数据库里面的表也被删除了,好可怕。使用false直接关闭这个配置功能。

至此整合已经完成了,没有很多复杂的内容,这就是使用了spring boot带来的便利性,如果是spring mvc的话,还要通过xml配置或者Configuration配置类来设置JPA的相关属性,过程要复杂的很多。

基本使用示例

实体类

在JPA中,指定数据表中的字段和实体类的字段映射关系是通过实体类中的注解实现的。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
@Entity
@Table(name="t_user")
@EntityListeners({AuditingEntityListener.class})
public class User {
@Id
@GeneratedValue(strategy = GenerationType.AUTO)
@Column(name="id")
public Integer id;
@Column(name="user_name")
public String userName;
@Column(name="user_phone")
public String userPhone;
@Column(name="age")
public Integer age;
@Column(name="address")
public String address;
}
  • @Entity注解是为了表明当前的的类是实体类
  • @Table指定当前实体类所对应的表名
  • @Id指定当前的字段是主键
  • @GeneratedValue指定注解的生成规则
  • @Column指定当前字段映射到数据中表的字段名(如果当前的这个字段是数据库的关键字需要在name值上加”[]”,如@Column(name="[index]")

使用了@Entity注解后会默认映射到数据库的表,按照驼峰规则,如类名是CustomerBaseInfo,那么就会对应到表名为customer_base_info表,此时就不需要@Table注解来指定表名了。另外就是@Column注解,是指定字段的映射关系,同样的是可以通过驼峰规则自动匹配。

Repository接口类

在Mybatis中是定义Mapper接口类,在JPA中使用的是Repository接口,实现的方式和Mybatis中有所不同。

1
2
3
4
5
6
7
8
9
10
11
public class UserRepository extends JpaRepository<User,Integer>{

User findByUserName(@Param("userName")String userName);

@Query("select u from User u where u.userPhone=:userPhone")
User findUserByPhone(@Param("userPhone")String userPhone);

@Modifying
@Query("update User u set u.address=:address where u.id=:id")
int updateAddressById(@Param("address")String address,@Param("id")Integer id);
}
  • 第一个方法findByUserName是不需要写对应的SQL语句的,JPA会根据方法名自动生成SQL,这就是JPA的强大之处;
  • 第二个方法通过@Query注解,在注解中写对应SQL,体现一下写SQL的基本语法,注意的是JPA是面向对象的,一切都是用对象实现,包括表名也是用的直接实体类的名称,JPA的SQL有一个专业的叫法是JPQL;
  • 第三个方法是修改表的记录,需要注意的是在修改的时候需要加上@Modifying注解,如果没有这个注解会报错的

关于JPA的各种实现方式有很多,表达式的写法也有很多。后面更新文章将会细讲。

单元测试
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
@RunWith(SpringJUnit4ClassRunner.class)
@SpringBootTest(classes = {ItcrudJpaApplication.class})
public class JPATest {

@Autowired
private UserService userService;

@Test
public void findByUserNameTest() {
User user = userService.findByUserName("Joker");
System.out.println(user);
}

@Test
public void updateAddressByIdTest() {
int i = userService.updateAddressById("安徽六安", 1);
System.out.println("====>" + i);
}

@Test
public void findUserByPhoneTest(){
User user = userService.findUserByPhone("15611223344");
System.out.println(user);
}
}

在写Junit测试的时候遇到两个问题,下面提一下。

  • JPA涉及到update、delete的时候必须在方法上加@Transactional注解开启事务,否则会抛出TransactionRequiredException异常。
  • 接上面的问题,如果直接在test方法上加@Transactional注解,会出现自动回滚的情况,也就是在执行完整个test后,方法是自动回滚,这是test中的保护机制(之前不知道,现在扫个盲)。

简单的整合,简单的使用,对于一个正常业务系统来说,总是存在各种各样的SQL,先埋个坑,后续更新跟上。

微信公众号


本文作者:IT-CRUD
原文地址:http://blog.itcrud.com/blogs/2018/10/spring-jpa-base-sping-using
版权归作者所有,转载请注明出处

推荐文章

支付宝 微信

如果文章对你有帮助,欢迎点击上方按钮打赏作者