相信大多数的Java后端开发者都听说过MyBatis,但是用过JPA的人却相对较少,有些人可能没有听说过。JPA在国外比较火用的人也比较多,国内大多被MyBatis的简单易上手所吸引。相对的,JPA和MyBatis二者之间并没有可比性,它们所在的层次不一样,MyBatis和Hibernate一样属于ORM层级,而JPA则是在ORM之上Spring做了一些高度的封装,使之更便于使用。很多人觉得它的学习成本比较高,其实不然。接下来盘点下JPA中的一些使用方法。
JPA官方文档:https://docs.spring.io/spring-data/jpa/docs//reference/html
依赖引入
org.springframework.boot
spring-boot-starter-data-jpa
使用SQL进行CRUD
编写SQL语句是最基础的操作,它支持JPQL、HQL(语法无关数据库类型,底层会自动生成对应数据库的SQL如MySQL)和原生SQL(需要开发者保证语法与当前连接的数据库一致)。
示例代码,以下使用了JPQL的语法
@Repository
public interface UserDao extends JpaRepository {
//获取某条数据
@Query(value = "select user from User r where r.username=:username")
User findFirstByUsername(@Param("username") String username);
//也可以获取某一个字段,而不是整行数据
@Query(value = "select user.username from User r where r.id=:id")
String getUsernameById(@Param("id") Long id);
//删除一条数据,注意这里不写SQL语句也是可以的,语义判定,后面会讲
@Modifying
void deleteUserById(Long id)
}
保存和更新则更加简单,直接调用save方法,传入实体类实例。
public class UserServiceImpl implements UserService {
@Autowired
private UserDao userDao;
@Override
@Transactional(rollbackFor = Throwable.class)
public void createUser(User user) {
//创建和更新都是使用的save
userDao.save(user);
}
}
以上就是最基础最简单的用法。
如何执行数据库原生SQL?
上面的章节都是使用了数据库无关的JPQL语法格式,如果想执行某数据库特有的SQL函数时,可以指定使用原生SQL,如下代码引用了官方文档:
public interface UserRepository extends JpaRepository {
@Query(value = "SELECT * FROM USERS WHERE LASTNAME = ?1",
countQuery = "SELECT count(*) FROM USERS WHERE LASTNAME = ?1",
nativeQuery = true)
Page findByLastname(String lastname, Pageable pageable);
}
以上代码中使用nativeQuery = true指定了使用原生的SQL,值得注意的是,如果后期更换了数据库服务,比如从MySQL改为了Oracle,这块代码就极有可能不兼容。 Pageable pageable是分页信息。
无需写SQL,根据方法语义自动生成实现方法
先看下如下代码
public interface UserRepository extends Repository {
List findByEmailAddressAndLastname(String emailAddress, String lastname);
}
可以看出,我没有写任何SQL,也不需要实现该接口,就可以直接使用该接口进行查询。这就是JPA的智能语义分析机制,它在源码中的实现原理是运行时生成一个代理类,注入到依赖的bean中,根据方法的语义生成实际执行的SQL语句。
如上述代码中方法名findByEmailAddressAndLastname中的findBy便是一个查询的主题关键字,EmailAddress和Lastname是User表中的字段,And则是判断的关键字。于是,该方法名的含义是根据email地址和lastname查询用户列表。那么在生成代理方法时就会根据这些关键字生成SQL语句。
常用的主题关键字有findBy、getBy、deleteXxxBy、countXxxBy等,条件判断的关键字有And、Or、In等。
更多的关键字及用法可以查阅官方文档:https://docs.spring.io/spring-data/jpa/docs//reference/html/#appendix.query.method.predicate
如何只查询部分字段并自动填充返回Pojo/DTO实例?
查询整行数据是很有可能造成回表查询的,除非是聚簇索引下使用主键查询,因此大多数情况下是只查询业务关心的字段,而不是整行数据。
通常情况下,一个表对应了一个实体类
以下是一个实体类的定义示例:
@javax.persistence.Table(name = "test_user", uniqueConstraints = {@UniqueConstraint(columnNames = {"username", "emailAddress"})})
@javax.persistence.Entity
public class User implements Serializable {
private Long id;
private String role;
private String username;
private String emailAddress;
@Id
@GenericGenerator(name="snowFlakeIdGenerator", strategy="自定义的id生成策略类")
@GeneratedValue(generator="snowFlakeIdGenerator")
@JsonFormat(shape = JsonFormat.Shape.STRING) //Java中的long比js中的长,使用String传输
public Long getId() {
return id;
}
public void setId(Long id) {
this.id = id;
}
public String getRole() {
return role;
}
public void setRole(String role) {
this.role = role;
}
public String getUsername() {
return username;
}
public void setUsername(String username) {
this.username = username;
}
}
接下来定义一个对外接口中用于传输的DTO类
package com.demo.dto;
public class UserInfoDTO {
private Long id;
private String username;
private String emailAddress;
//定义一个有参的构造函数,用于在JPQL语句中构建DTO的实例
public UserInfoDTO(Long id, String username, String emailAddress) {
this.id = id;
this.username = username;
this.emailAddress = emailAddress;
}
public UserInfoDTO() {
}
// 以下Set、Get方法省略
}
查询部分字段,并将字段构造成Pojo/DTO对象
public interface UserRepository extends Repository {
//注意这里返回的是UserInfoDTO而不是User,因此需要编写JPQL语句
@Query(value = "select new com.demo.dto.UserInfoDTO(r.id, r.username, r.emailAddress) from User r where r.username=:username")
UserInfoDTO getUserInfoByName(String username);
}
代码中select new com.demo.dto.UserInfoDTO(r.id, r.username, r.emailAddress)是将查到的id、username、emailAddress字段作为构造参数传入构建UserInfoDTO实例,没有进行整表查询。
其返回的UserInfoDTO实例就是最终需要的,不需要先查出来User在进行复制。
多表连接查询
在JPA中也可以直接使用JPQL进行多表连接查询。上一章节讲到了可以将查询到的结果返回自定义的类,只需要重载一个有参的构造函数。与普通的SQL无异,在JPQL的语句中也可以使用left join等关键字,将需要的字段信息传入构造函数中即可。