JPA查询方式----Java持久化API(3)

叁歲伎倆 2021-09-01 09:37 364阅读 0赞

# JPA的查询方式 #

## 使用约定的方法名 ##

约定方法名一定要根据命名规范来写，Spring Data会根据前缀、中间连接词（Or、And、Like、NotNull等类似SQL中的关键词）、内部拼接SQL代理生成方法的实现。约定方法名的方法见下表：

<table> 
 <thead> 
  <tr> 
   <th>SQL</th> 
   <th>方法例子</th> 
   <th>JPQL语句</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>and</td> 
   <td>findByLastnameAndFirstname</td> 
   <td>where x.lastname = ?1 and x.firstname = ?2</td> 
  </tr> 
  <tr> 
   <td>or</td> 
   <td>findByLastnameOrFirstname</td> 
   <td>where x.lastname = ?1 or x.firstname = ?2</td> 
  </tr> 
  <tr> 
   <td>=</td> 
   <td>findByFirstname,findByFirstnamels,findByFirstnameEquals</td> 
   <td>where x.firstname = ?1</td> 
  </tr> 
  <tr> 
   <td>between xxx and xxx</td> 
   <td>findByStartDateBetween</td> 
   <td>where x.startDate between ?1 and ?2</td> 
  </tr> 
  <tr> 
   <td>&lt;</td> 
   <td>findByAgeLessThan</td> 
   <td>where x.age &lt; ?1</td> 
  </tr> 
  <tr> 
   <td>&lt;=</td> 
   <td>findByAgeLessThanEqual</td> 
   <td>where x.age &lt;= ?1</td> 
  </tr> 
  <tr> 
   <td>&gt;</td> 
   <td>findByAgeGreaterThan</td> 
   <td>where x.age &gt;?1</td> 
  </tr> 
  <tr> 
   <td>&gt;=</td> 
   <td>findByAgeGreaterThanEqual</td> 
   <td>where x.age &gt;= ?1</td> 
  </tr> 
  <tr> 
   <td>&gt;</td> 
   <td>findByStartDateAfter</td> 
   <td>where x.startDate &gt; ?1</td> 
  </tr> 
  <tr> 
   <td>&lt;</td> 
   <td>findByStartDateBefore</td> 
   <td>where x.startDate &lt; ?1</td> 
  </tr> 
  <tr> 
   <td>is null</td> 
   <td>findByAgeIsNull</td> 
   <td>where x.age is null</td> 
  </tr> 
  <tr> 
   <td>is not nul</td> 
   <td>findByAge(Is)NotNull</td> 
   <td>where x.age not null</td> 
  </tr> 
  <tr> 
   <td>like</td> 
   <td>findByFirstnameLike</td> 
   <td>where x.firstname like ?1</td> 
  </tr> 
  <tr> 
   <td>not like</td> 
   <td>findByFirstnameNotLike</td> 
   <td>where x.firstname not like ?1</td> 
  </tr> 
  <tr> 
   <td>like ‘xxx%’</td> 
   <td>findByFirstnameStartingWith</td> 
   <td>where x.firstname like ?1(parameter bound with appended %)</td> 
  </tr> 
  <tr> 
   <td>like ‘xxx%’</td> 
   <td>findByFirstnameEndingWith</td> 
   <td>where x.firstname like ?1(parameter bound with prepended %)</td> 
  </tr> 
  <tr> 
   <td>like ‘%xxx%’</td> 
   <td>findByFirstnameContaining</td> 
   <td>where x.firstname like ?1(parameter bound with wrapped %)</td> 
  </tr> 
  <tr> 
   <td>order by</td> 
   <td>findByAgeOrderByLastnameDesc</td> 
   <td>where x.age = ?1 order by x.lastname desc</td> 
  </tr> 
  <tr> 
   <td>&lt;&gt;</td> 
   <td>findByLastnameNot</td> 
   <td>where x.lastname &lt;&gt; ?1</td> 
  </tr> 
  <tr> 
   <td>in()</td> 
   <td>findByAgeIn(Collection&lt; Age &gt; ages)</td> 
   <td>where x.age in ?1</td> 
  </tr> 
  <tr> 
   <td>not in()</td> 
   <td>findByAgeNotIn(Collection&lt; Age &gt; ages)</td> 
   <td>where x.age not in ?1</td> 
  </tr> 
  <tr> 
   <td>TRUE</td> 
   <td>findByActiveTrue()</td> 
   <td>where x.active = true</td> 
  </tr> 
  <tr> 
   <td>FALSE</td> 
   <td>findByActiveFalse()</td> 
   <td>where x.active = false</td> 
  </tr> 
 </tbody> 
</table>

--------------------

接口方法的命名规则也很简单，只要明白 And、Or、Is、Equal、Greater、StartingWith等英文单词的含义，就可以写接口的方法。例：

public  interface  UserRepository extends  Repository<User, Long>{
    	List<User> findByEmailOrName(String email,String name);
    }

上述代码表示用email或name来查找User对象  
约定的方法还可以支持一下几种语法：

*  User findFirstByOrderByNameAsc()。
 *  Page< User > queryFirst100ByName(String name, Pageable pageable)
 *  Slice< User > findByTop100ByName(String name, Pageable pageable)
 *  List< User > findFirst100ByName(String name, Sort sort)
 *  List< User > findTop100ByName(String name, Pageable pageable)

## 用JPQL进行查询 ##

JPQL语言( Java Persistence Query Language )是一种和SQL非常类似的中间件和对象化查询语言，它最终会被编译成针对不同底层数据库的SQL语言，从而屏蔽不同数据库的差异。

JPQL语言通过Query接口封装执行，Query接口封装了执行数据库查询的相关方法。调用EntityManager的Query、NamedQuery、NativeQuery方法可以获得查询对象，进而可调用Query接口的方法来执行查询操作。

JPQL是面向对象进行查询的语言。可以通过自定义的JPQL完成UPDATE和DELETE操作。JPQL不支持使用INSERT。对于UPDATE和DELETE操作，必须使用注解@Modifying进行修饰

*JPQL用法见下面两段代码*

*  根据name值进行查找

public  interface  UserRepository extends  Repository<User, Long>{
       	@Query("select u from  User u where  u.name=?1")
       	User findByName(String name);
       }

*  根据name值进行模糊查找

public  interface  UserRepository extends  Repository<User, Long>{
       @Query("select u from  User u where  u.name like %?1")
       User findByName(String name);
    }

*  查询一个表中的一些字段

方法一：这段代码返回的是一个Object类型
    @Query(value = "select b.title, b.state,b.remark,b.publisherTime,b.publisherId from BizNotice b where b.lineId = ?1 AND b.bidspartId = ?2 AND b.areaId = ?3")
    	public List<BizNotice> noticeList(String lineId, String bidspartId, String areaId);
    
    方法二：这段代码返回的是一个对象形式
    @Query(value = "select new BizNotice(b.title,b.id,b.content,b.publisherId,b.state)  from BizNotice b where b.lineId = ?1 AND b.bidspartId = ?2 AND b.areaId = ?3")
    	public List<BizNotice> noticeList(String lineId, String bidSpartId, String areaId);

### 用原生的SQL进行查询 ###

在使用原生SQL查询时，也使用注解@Query。此时，nativeQuery参数需要设置为true。

*  根据ID查询用户

public  interface  UserRepository extends JpaRepository<User, Long> {
       @Query(value = "select  * from user u where u.id=:id",nativeQuery = true)
       User findById(@Param("id")Long id);
    }

*  查询所有用户

interface  UserRepository extends JpaRepository<User, Long> {
       @Query(value = "select  * from user",nativeQuery = true)
       List<User> findAllNative ();
    }

*  根据email查询用户

public  interface  UserRepository extends JpaRepository<User, Long> {
       @Query(value = "select  * from user where email =?1",nativeQuery = true)
       List<User> findByEmail ();
    }

*  根据name查询用户，并返回分页对象Page

public interface  UserRepository extends JpaRepository<User, Long> {
       @Query(value = "select  * from user where name =?1",
       		countQuery = "select count(*)from user where name=?1",
       		nativeQuery = true)
       List<User> findByName (String name, Pageable pageable);
    }

*  根据名字来修饰email的值

@Modifying
       @Query("update user set email=:email where name=:name")
       void  updateUserEmailByName(@Param("name")String name,@Param("email")String email);

可以看到，@Query与@Modifying这两个注解一起声明，可以定义个性化更新操作

*  使用事物  
    UPDATE或DELETE操作需要使用事物。此时需要先定义Service层，然后在Service层的方法上添加事物操作。对于自定义的方法，如果需要改变Spring Data提供的事物默认方式，则可以在方法上使用注解@Transactional，如下代码

@Service
    public class UserService{
       @Autowired
       private UserRepository  userRepository ;
       @Transactional
       public void updateEmailByName(String name, String email){
       	userRepository.updateEmailByName(name, eamil);
     }
    }

在进行多个Repository操作时，也应该使这些操作在同一事物中。按照分层架构的思想，这些操作属性属于业务逻辑层，因此也需要在Service层实现对多个Repository的调用，并在相应的方法上声明事物

### 用Specifications进行查询 ###

如果要使用Repository支持Specification查询，则需要在Repository中继承JpaSpecificationExecutor，具体见下面代码

public interface ArticleRepository extends JpaRepository<Article,Long> , JpaSpecificationExecutor<Article> {
        Article findById(long id);
    }

*说明Specification的具体用法*

@RunWith(SpringRunner.class)
    @SpringBootTest
    public class JpaArticleDemoApplicationTests {
    
    	@Autowired
    	ArticleRepository articleRepository;
    	@Test
    	public void contextLoads() {
    		int pageNo = 0;
    		int pageSize = 5;
    		PageRequest pageable = PageRequest.of(pageNo,pageSize);
    		//通常使用Specification的匿名内部类
    		Specification<Article> specification = new Specification<Article>() {
    			@Override
    			public Predicate toPredicate(Root<Article> root, CriteriaQuery<?> criteriaQuery, CriteriaBuilder cb) {
    				Path path = root.get("id");
    				Predicate predicate1 = cb.gt(path,2);
    				Predicate predicate2 = cb.equal(root.get("num"),422803);
    				Predicate predicate = cb.and(predicate1,predicate2);
    				return predicate;
    			}
    		};
    		Page<Article> page = articleRepository.findAll(specification,pageable);
    		System.out.println("总记录数："+page.getTotalElements());
    		System.out.println("当前第：" +(page.getNumber()+1) + "页");
    		System.out.println("总页数：" +page.getTotalPages());
    		System.out.println("当前页面的List" + page.getContent());
    		System.out.println("当前页面的记录数："+page.getNumberOfElements());
    	}
    }

*  CriteriaQuery接口：specific的顶层查询对象，它包含查询的各个部分，比如：select, from, where, group by, order by等。CriteriaQuery对象只对实体类型或嵌入式类型的Criteria查询起作用
 *  root: 代表查询的实体是Criteria查询的根对象。Criteria查询的根定义了实体类型，能为将来的导航获得想要的结果。它与SQL查询中的from子句类似。
 *  Root实体是类型化的且规定了from子句中能够出现的类型。查询根实体通过传入一个实体类型给AbstractQuery.from方法获得
 *  query: 可以从中得到Root对象，即告知JPA Criteria查询要查询哪一个实体类。还可以添加查询条件，并结合EntityManager对象得到最终查询的TypedQuerty对象
 *  CriteriaBuilder对象：用于创建Criteria相关对象的工厂，可以从中获得到Predicate对象
 *  Predicate类型：代表一个查询条件

### 用ExampleMatcher进行查询 ###

Spring Data 可以通过Example对象来构造JPQL查询。代码如下：

Member member = new Member();
    		//构建查询条件
    		member.setRealName("fyh");
    		ExampleMatcher matcher = ExampleMatcher.matching()
    		//创建一个ExampleMatcher，不区分大小写匹配name
    		.withIgnorePaths("name")
    		//包括null值
    		.withIncludeNullValues()
    		//执行后缀匹配
    		.withStringMatcheEnding();
    		//通过Example来构建查询
    		Example<Member> example = Example.of(member,matcher);
    		List<Member> list = memberDao.findALL(example);

默认情况，ExampleMatcher会匹配所有字段  
可以指定单个属性的行为（如name或内嵌数据“name.user”）。如：

*  .withMatcher(“name”,endsWith())。
 *  .withMatcher(“name”,startsWith().ignoreCase())。

### 用谓语QueryDSL进行查询 ###

QueryDSL也是基于各种ORM之上的一个通用查询框架，它与SpringDataJPA是同级别的。使用QueryDSL的API可以写出SQL语句（java代码，非标准SQL），不需要懂SQL语句。他能够构建类型安全的查询。这个与JPA使用原生查询时有很大不同，可以不必再对“Object\[\]”进行操作，它还可以和JPA进行联合。

--------------------

文章节选自《SpringBoot实战派》