本文章来自【知识林】
上一篇文章《Springboot 之 JPA对Mysql数据库的增删改查》中介绍了使用JpaRepository
中的方法对数据库的一些简单操作,下面将介绍一下使用自定义的方式来完成数据库的操作,通过这篇文章更能看出Jpa
的强大与方便。
为了更好的测试,批量添加几条数据到数据库中:
@SpringBootTest
@RunWith(SpringRunner.class)
public class UserTest {
@Autowired
private IUserService userService;
@Test
public void testAdd() {
for(Integer i=0; i < 5; i++) {
User user = new User();
user.setNickName("昵称"+i);
user.setUserName("user"+i);
user.setPassword("pwd"+i);
user.setEmail("email"+i+"@domain.com");
userService.save(user);
}
}
}
- 通过字段获取数据
通过Id获取数据(这个功能可以使用方法findOne(id)
实现,但这里不使用此方法)
在IUserService
接口中增加方法User findById(Integer id);
public interface IUserService extends JpaRepository<User, Integer> {
User findById(Integer id);
}
测试方法:
@Test
public void testFindById() {
User u = userService.findById(3);
System.out.println("nickName : "+u.getNickName()+", email : "+u.getEmail());
}
注意:在findById
这个方法中没有任何SQL或HQL语句,但在运行测试方法:testFindById()
后依然输出了正确的结果:nickName : 昵称2, email : email2@domain.com
通过用户名获取用户
只需要在接口IUserService
中加入方法:User findByUserName(String userName);
测试方法:
@Test
public void testFindByUserName() {
User u = userService.findByUserName("user3");
System.out.println("nickName : "+u.getNickName()+", email : "+u.getEmail());
}
注意: 在运行测试方法:testFindByUserName()
后也依然输出了正确的结果:nickName : 昵称3, email : email3@domain.com
通过用户名和密码获取用户
在接口IUserService
中加入方法:User findByUserNameAndPassword(String userName, String password);
测试方法:
@Test
public void testFindByNameAndPwd() {
User u = userService.findByUserNameAndPassword("user4", "pwd4");
System.out.println("nickName : "+u.getNickName()+", email : "+u.getEmail());
}
注意:运行测试方法:testFindByNameAndPwd()
后也输出了正确的结果:nickName : 昵称4, email : email4@domain.com
通过上面几个例子可以想到:Spring Data Jpa提供了一些关键字的查询方法,查询相关文档得出:
都需要以findBy
开头,且方法中的字段名必须与实体类中的属性名一致,并遵循驼峰式代码编写风格
And
:等价于SQL中的and
关键字,比如:findByUserNameAndPassword(String username, String pwd)
;
Or
:等价于SQL中的or
关键字,比如:findByUserNameOrEmail(String username, String email)
;
Between
:等价于between
关键字(介于两者之间),比如:findByAgeBetween(int max, int min)
(获取age在max和min之间的数据);
LessThan
:等价于<
,比如:findByAgeLessThan(int val)
(获取age小于val的数据);
GreaterThan
:等价于>
,比如:findByAgeGreaterThan(int val)
(获取age大于val的数据);
IsNull
:等价于is null
,比如:findByEmailIsNull()
(获取email为空的数据);
IsNotNull
:等价于is not null
,比如:findByEmailIsNotNull()
(获取email不为空的数据);
NotNull
:等价于IsNotNull
;
Like
:等价于like
,比如:findByUserNameLike(String val)
(获取userName中包含val的数据,在传入val的时候可以在首尾处加上%
);
NotLike
:等价于not like
,比如:findByUserNameNotLike(String val)
(获取userName中不包含val的数据,在传入val的时候也可以在首尾处加上%
);
Not
:等价于!=
,比如:findByUserNameNot(String val)
(获取userName不等于val的数据);
In
:等价于in
,比如:findByUserNameIn(Collection<String> vals)
或findByUserNameIn(String... vals)
(获取userName在集合vals中的数据,参数类型可以是集合,也可以是数组,或不指定长度的数组);
NotIn
:等价于not in
,,比如:findByUserNameNotIn(Collection<String> vals)
或findByUserNameNotIn(String... vals)
(获取userName不在集合vals中的数据,参数类型可以是集合,也可以是数组,或不指定长度的数组);
OrderBy
:等价于order by
,比如:findByUserNameOrderByIdAsc(String userName)
(Asc
也可以换成Desc
来更换排序方式);
- 以HQL方式获取数据
前面介绍的获取数据的方式都没有使用到任何的HQL语句,那些方法已经可以满足很多需求,也有时候会觉得方法名太长不太方便,下面介绍一下使用Hql方式获取数据:
在IUserService
中加入 :
@Query("FROM User u WHERE u.userName=?1 AND u.password IS NOT NULL")
List<User> findAll(String userName);
测试方法:
@Test
public void testQuery() {
List<User> list = userService.findAll("user3");
System.out.println(list.size());
}
- 修改数据
在IUserService
接口中写一个修改的方法,只要涉及修改或删除数据的操作都需要加上注释@Modifying
和@Transcational
(Transcational
是org.springframework.transaction.annotation
包中的不要导错了)
@Query("UPDATE User u SET u.password=?2 WHERE u.userName=?1")
@Modifying
@Transactional
void updatePwd(String userName, String pwd);
测试方法:
@Test
public void testUpdate() {
userService.updatePwd("user1", "123456");
}
- 删除数据
在IUserService
接口中的方法:
@Query("DELETE FROM User u WHERE u.userName=?1")
@Modifying
@Transactional
void deleteByUserName(String userName);
测试方法:
@Test
public void testDelete() {
userService.deleteByUserName("user4");
}
在上面的操作方式中参数传递都是以一种有序的方式传递的,另外还有一种更为直观的方式来传递参数,下面举个例子说明:
在接口IUserService
中添加方法:
@Query("UPDATE User u SET u.email= :email WHERE u.userName = :user")
@Modifying
@Transactional
void updateEmail(@Param("user") String userName, @Param("email") String email);
测试方法:
@Test
public void testUpdate2() {
userService.updateEmail("user2", "user2@qq.com");
}
注意: 在参数传中参数前加注释@Param
并指定名称,在@Query
中使用:名称
的方式来传递参数。
示例代码:https://github.com/zsl131/spring-boot-test/tree/master/study07
本文章来自【知识林】