在本文之前,本应当专门有一篇博客讲解SpringDataJPA使用自带的Specification+JpaSpecificationExecutor去说明如何玩条件查询,但是看到新奇、编码更简单易懂的技术总是会让人感到惊喜,而且QueryDSL对SpringDataJPA有着完美的支持。如果你没有使用过自带的Specification去做复杂查询,不用担心,本节分享的QueryDSL技术与SpringDataJPA自带支持的Specification没有关联。注意,本文内容一切都是基于SpringBoot1.x上构建的,如果还没有使用过SpringBoot的伙伴,请移步SpringBoot进行初步入门。

1、QueryDSL简介

  如果说Hibernate等ORM是JPA的实现,而SpringDataJPA是对JPA使用的封装,那么QueryDSL可以是与SpringDataJPA有着同阶层的级别,它也是基于各种ORM之上的一个通用查询框架,使用它的API类库可以写出“Java代码的sql”,不用去手动接触sql语句,表达含义却如sql般准确。更重要的一点,它能够构建类型安全的查询,这比起JPA使用原生查询时有很大的不同,我们可以不必再对恶心的“Object[]”进行操作了。当然,我们可以SpringDataJPA + QueryDSL JPA联合使用,它们之间有着完美的相互支持,以达到更高效的编码。

2、QueryDSL JPA的使用

2.1 编写配置

2.1.1 pom.xml配置

在maven pom.xml的plugins标签中配置以下plugin:


   
  1. <build>
  2. <plugins>
  3. <!--其他plugin...........-->
  4. <!--因为是类型安全的,所以还需要加上Maven APT plugin,使用 APT 自动生成一些类:-->
  5. <plugin>
  6. <groupId>com.mysema.maven </groupId>
  7. <artifactId>apt-maven-plugin </artifactId>
  8. <version>1.1.3 </version>
  9. <executions>
  10. <execution>
  11. <phase>generate-sources </phase>
  12. <goals>
  13. <goal>process </goal>
  14. </goals>
  15. <configuration>
  16. <outputDirectory>target/generated-sources </outputDirectory>
  17. <processor>com.querydsl.apt.jpa.JPAAnnotationProcessor </processor>
  18. </configuration>
  19. </execution>
  20. </executions>
  21. </plugin>
  22. </plugins>
  23. </build>

继续在pom.xml 的dependencies中配置以下依赖:


   
  1. <dependencies>
  2. <!--SpringDataJPA-->
  3. <dependency>
  4. <groupId>org.springframework.boot </groupId>
  5. <artifactId>spring-boot-starter-data-jpa </artifactId>
  6. </dependency>
  7. <!--Web支持-->
  8. <dependency>
  9. <groupId>org.springframework.boot </groupId>
  10. <artifactId>spring-boot-starter-web </artifactId>
  11. </dependency>
  12. <!--QueryDSL支持-->
  13. <dependency>
  14. <groupId>com.querydsl </groupId>
  15. <artifactId>querydsl-apt </artifactId>
  16. <scope>provided </scope>
  17. </dependency>
  18. <!--QueryDSL支持-->
  19. <dependency>
  20. <groupId>com.querydsl </groupId>
  21. <artifactId>querydsl-jpa </artifactId>
  22. </dependency>
  23. <!--mysql驱动-->
  24. <dependency>
  25. <groupId>mysql </groupId>
  26. <artifactId>mysql-connector-java </artifactId>
  27. <scope>runtime </scope>
  28. </dependency>
  29. <dependency>
  30. <groupId>org.springframework.boot </groupId>
  31. <artifactId>spring-boot-starter-test </artifactId>
  32. <scope>test </scope>
  33. </dependency>
  34. <!-- https://mvnrepository.com/artifact/org.projectlombok/lombok -->
  35. <dependency>
  36. <groupId>org.projectlombok </groupId>
  37. <artifactId>lombok </artifactId>
  38. <version>1.16.10 </version>
  39. <scope>provided </scope>
  40. </dependency>
  41. </dependencies>

2.1.2 application.properties配置

application.properties与之前几篇SpringDataJPA文章的application.yml配置作用是相同的,配置如下:


   
  1. server.port= 8888
  2. server.context-path=/
  3. server.tomcat.uri-encoding=utf -8
  4. #数据源配置
  5. spring.datasource.url=jdbc:mysql: //127.0.0.1:3306/springboot_test?characterEncoding=utf8
  6. #数据库账号
  7. spring.datasource.username=root
  8. #数据库密码
  9. spring.datasource.password=
  10. spring.jpa.database=mysql
  11. #是否展示sql
  12. spring.jpa.show-sql= true
  13. #是否自动生/更新成表,根据什么策略
  14. spring.jpa.hibernate.ddl-auto=update
  15. #命名策略,会将Java代码中的驼峰命名法映射到数据库中会变成下划线法
  16. spring.jpa.hibernate.naming.strategy=org.hibernate.cfg.ImprovedNamingStrategy

2.1.3 JPAQueryFactory配置

使用QueryDSL的功能时,会依赖使用到JPAQueryFactory,而JPAQueryFactory在这里依赖使用EntityManager,所以在主类中做如下配置,使得Spring自动帮我们注入EntityManager与自动管理JPAQueryFactory:


   
  1. @SpringBootApplication
  2. public class App {
  3. public static void main(String[] args) {
  4. SpringApplication.run(App.class, args);
  5. }
  6. //让Spring管理JPAQueryFactory
  7. @Bean
  8. public JPAQueryFactory jpaQueryFactory(EntityManager entityManager){
  9. return new JPAQueryFactory(entityManager);
  10. }
  11. }

2.1.4 编写实体建模

在这里我们先介绍单表,待会儿介绍多表时我们在进行关联Entity的配置


   
  1. @Data
  2. @Entity
  3. @Table(name = "t_user")
  4. public class User {
  5. @Id
  6. @GeneratedValue(strategy = GenerationType.IDENTITY)
  7. private Integer userId;
  8. private String username;
  9. private String password;
  10. private String nickName;
  11. private Date birthday;
  12. private BigDecimal uIndex; //排序号
  13. }

这个实体类非常简单,相信大家一定有所理解。没有使用过@Data注解,也可以不用,暂且就将他当做可以自动生成getXXX/setXXX方法的工具,如果你没有使用这个注解,也可以直接使用IDEA快捷键进行生成setXXX/getXXX。如果想了解这类注解,请前往lombok介绍

2.1.5 执行maven命令

然后在IDEA中选中你的MavenProject按钮,选中你的maven项目,双击compile按钮:

如果你的控制台提示你compile执行失败了,那么请留意一下你的maven路径是否在IDEA中进行了正确的配置。

以上步骤执行完毕后,会在你的target中自动生成了QUser类:

该类中的代码大致是这样的:


   
  1. @Generated( "com.querydsl.codegen.EntitySerializer")
  2. public class QUser extends EntityPathBase<User> {
  3. private static final long serialVersionUID = - 646136422L;
  4. public static final QUser user = new QUser( "user");
  5. public final DateTimePath<java.util.Date> birthday = createDateTime( "birthday", java.util.Date.class);
  6. public final StringPath nickName = createString( "nickName");
  7. public final StringPath password = createString( "password");
  8. public final NumberPath<java.math.BigDecimal> uIndex = createNumber( "uIndex", java.math.BigDecimal.class);
  9. public final NumberPath<Integer> userId = createNumber( "userId", Integer.class);
  10. public final StringPath username = createString( "username");
  11. public QUser(String variable) {
  12. super(User.class, forVariable(variable));
  13. }
  14. public QUser(Path<? extends User> path) {
  15. super(path.getType(), path.getMetadata());
  16. }
  17. public QUser(PathMetadata metadata) {
  18. super(User.class, metadata);
  19. }
  20. }

一般每有一个实体Bean配置了@Entity被检测到之后,就会在target的子目录中自动生成一个Q+实体名称 的类,这个类对我们使用QueryDSL非常重要,正是因为它,我们才使得QueryDSL能够构建类型安全的查询。

2.2 使用

2.2.1 单表使用

在repository包中添加UserRepository,使用QueryDSL时可以完全不依赖使用QueryDslPredicateExecutor,但是为了展示与SpringDataJPA的联合使用,我们让repository继承这个接口,以便获得支持:


   
  1. public interface UserRepository extends JpaRepository<User, Integer>, QueryDslPredicateExecutor<User> {
  2. }

为了讲解部分字段映射查询,我们在bean包创建一个UserDTO类,该类只有User实体的部分字段:


   
  1. @Data
  2. @Builder
  3. public class UserDTO {
  4. private String userId;
  5. private String username;
  6. private String nickname;
  7. private String birthday;
  8. }

对于@Data与@Buider,都是lombok里的注解,能够帮我们生成get/set、toString方法,还能使用建造者模式去创建UserDTO,如果不会的同学也可以使用IDE生成get/set,想了解的同学可以进入lombok进行简单学习。

在service包中添加UserService,代码如下:


   
  1. @Service
  2. public class UserService {
  3. @Autowired
  4. private UserRepository userRepository;
  5. @Autowired
  6. JPAQueryFactory jpaQueryFactory;
  7. //////////////////////////以下展示使用原生的dsl/////////////////////
  8. /**
  9. * 根据用户名和密码查找(假定只能找出一条)
  10. *
  11. * @param username
  12. * @param password
  13. * @return
  14. */
  15. public User findByUsernameAndPassword(String username, String password) {
  16. QUser user = QUser.user;
  17. return jpaQueryFactory
  18. .selectFrom(user)
  19. .where(
  20. user.username.eq(username),
  21. user.password.eq(password)
  22. )
  23. .fetchOne();
  24. }
  25. /**
  26. * 查询所有的实体,根据uIndex字段排序
  27. *
  28. * @return
  29. */
  30. public List<User> findAll() {
  31. QUser user = QUser.user;
  32. return jpaQueryFactory
  33. .selectFrom(user)
  34. .orderBy(
  35. user.uIndex.asc()
  36. )
  37. .fetch();
  38. }
  39. /**
  40. *分页查询所有的实体,根据uIndex字段排序
  41. *
  42. * @return
  43. */
  44. public QueryResults<User> findAllPage(Pageable pageable) {
  45. QUser user = QUser.user;
  46. return jpaQueryFactory
  47. .selectFrom(user)
  48. .orderBy(
  49. user.uIndex.asc()
  50. )
  51. .offset(pageable.getOffset()) //起始页
  52. .limit(pageable.getPageSize()) //每页大小
  53. .fetchResults(); //获取结果,该结果封装了实体集合、分页的信息,需要这些信息直接从该对象里面拿取即可
  54. }
  55. /**
  56. * 根据起始日期与终止日期查询
  57. * @param start
  58. * @param end
  59. * @return
  60. */
  61. public List<User> findByBirthdayBetween(Date start, Date end){
  62. QUser user = QUser.user;
  63. return jpaQueryFactory
  64. .selectFrom(user)
  65. .where(
  66. user.birthday.between(start, end)
  67. )
  68. .fetch();
  69. }
  70. /**
  71. * 部分字段映射查询
  72. * 投影为UserRes,lambda方式(灵活,类型可以在lambda中修改)
  73. *
  74. * @return
  75. */
  76. public List<UserDTO> findAllUserDto(Pageable pageable) {
  77. QUser user = QUser.user;
  78. List<UserDTO> dtoList = jpaQueryFactory
  79. .select(
  80. user.username,
  81. user.userId,
  82. user.nickName,
  83. user.birthday
  84. )
  85. .from(user)
  86. .offset(pageable.getOffset())
  87. .limit(pageable.getPageSize())
  88. .fetch()
  89. .stream()
  90. .map(tuple -> UserDTO.builder()
  91. .username(tuple.get(user.username))
  92. .nickname(tuple.get(user.nickName))
  93. .userId(tuple.get(user.userId).toString())
  94. .birthday( new SimpleDateFormat( "yyyy-MM-dd HH:mm:ss").format(tuple.get(user.birthday)))
  95. .build()
  96. )
  97. .collect(Collectors.toList());
  98. return dtoList;
  99. }
  100. /**
  101. * 部分字段映射查询
  102. * 投影为UserRes,自带的Projections方式,不够灵活,不能转换类型,但是可以使用as转换名字
  103. *
  104. * @return
  105. */
  106. /*public List<UserDTO> findAllDto2() {
  107. QUser user = QUser.user;
  108. List<UserDTO> dtoList = jpaQueryFactory
  109. .select(
  110. Projections.bean(
  111. UserDTO.class,
  112. user.username,
  113. user.userId,
  114. user.nickName,
  115. user.birthday
  116. )
  117. )
  118. .from(user)
  119. .fetch();
  120. return dtoList;
  121. }*/
  122. //////////////////////////以下展示使用与SpringDataJPA整合的dsl/////////////////////
  123. /**
  124. * 根据昵称与用户名查询,并且根据uIndex排序
  125. *
  126. * @param nickName
  127. * @return
  128. */
  129. public List<User> findByNicknameAndUsername(String nickName, String username) {
  130. QUser user = QUser.user;
  131. List<User> users = (List<User>) userRepository.findAll(
  132. user.nickName.eq(nickName)
  133. .and(user.username.eq(username)),
  134. user.uIndex.asc() //排序参数
  135. );
  136. return users;
  137. }
  138. /**
  139. * 统计名字像likeName的记录数量
  140. *
  141. * @return
  142. */
  143. public long countByNickNameLike(String likeName) {
  144. QUser user = QUser.user;
  145. return userRepository.count(
  146. user.nickName.like( "%" + likeName + "%")
  147. );
  148. }
  149. //////////////////////////展示dsl动态查询////////////////////////////////
  150. /**
  151. * 所有条件动态分页查询
  152. *
  153. * @param username
  154. * @param password
  155. * @param nickName
  156. * @param birthday
  157. * @param uIndex
  158. * @return
  159. */
  160. public Page<User> findByUserProperties(Pageable pageable, String username, String password, String nickName, Date birthday, BigDecimal uIndex) {
  161. QUser user = QUser.user;
  162. //初始化组装条件(类似where 1=1)
  163. Predicate predicate = user.isNotNull().or(user.isNull());
  164. //执行动态条件拼装
  165. predicate = username == null ? predicate : ExpressionUtils.and(predicate,user.username.eq(username));
  166. predicate = password == null ? predicate : ExpressionUtils.and(predicate,user.password.eq(password));
  167. predicate = nickName == null ? predicate : ExpressionUtils.and(predicate,user.nickName.eq(username));
  168. predicate = birthday == null ? predicate : ExpressionUtils.and(predicate,user.birthday.eq(birthday));
  169. predicate = uIndex == null ? predicate : ExpressionUtils.and(predicate,user.uIndex.eq(uIndex));
  170. Page<User> page = userRepository.findAll(predicate, pageable);
  171. return page;
  172. }
  173. /**
  174. * 动态条件排序、分组查询
  175. * @param username
  176. * @param password
  177. * @param nickName
  178. * @param birthday
  179. * @param uIndex
  180. * @return
  181. */
  182. public List<User> findByUserPropertiesGroupByUIndex(String username, String password, String nickName, Date birthday, BigDecimal uIndex) {
  183. QUser user = QUser.user;
  184. //初始化组装条件(类似where 1=1)
  185. Predicate predicate = user.isNotNull().or(user.isNull());
  186. //执行动态条件拼装
  187. predicate = username == null ? predicate : ExpressionUtils.and(predicate, user.username.eq(username));
  188. predicate = password == null ? predicate : ExpressionUtils.and(predicate, user.password.eq(password));
  189. predicate = nickName == null ? predicate : ExpressionUtils.and(predicate, user.nickName.eq(username));
  190. predicate = birthday == null ? predicate : ExpressionUtils.and(predicate, user.birthday.eq(birthday));
  191. predicate = uIndex == null ? predicate : ExpressionUtils.and(predicate, user.uIndex.eq(uIndex));
  192. //执行拼装好的条件并根据userId排序,根据uIndex分组
  193. List<User> list = jpaQueryFactory
  194. .selectFrom(user)
  195. .where(predicate) //执行条件
  196. .orderBy(user.userId.asc()) //执行排序
  197. .groupBy(user.uIndex) //执行分组
  198. .having(user.uIndex.longValue().max().gt( 7)) //uIndex最大值小于7
  199. .fetch();
  200. //封装成Page返回
  201. return list;
  202. }
  203. }

代码有点多,解释一波。

a、第一个方法是根据用户名与密码进行查询,QUser中有一个静态user属性,直接生成QUser的实例,QueryDSL都是围绕着这个QXxx来进行操作的。代码很直观,selectFrom是select方法与from方法的合并,这里为了方便就不分开写了,where中可以收可变参数Predicate,由于Predicate是一个接口,由user.username.eq或者user.uIndex.gt等等方法返回的都是BooleanExpression或者XXXExpression,这些XXXExpression都是Predicate的实现,故直接传入,让QueryDSL在内部做处理,其实Predicate也是实现了Expression接口,大家如果有兴趣可以自行跟踪源码研究。

b、第二个方法也相当的直观,跟sql的字面意思几乎一模一样。

c、第三个方法是第二个方法的排序写法,主要用到了offerset、limit方法,根据传入的pageable参数进行分页,最后返回的结果是一个QuerResults类型的返回值,该返回值对象简单的封装了一些分页的参数与返回的实体集,然调用者自己根据需求去取出使用。

d、第四个方法展示了日期查询,也相当的直观,大家尝试了就知道了,主要使用到了between方法。

e、第五个方法是比较重要的方法,这个方法展示了如何进行部分字段的映射查询,这个方法的目的是只查询uerrname、userId、nickname、birthday四个字段,然后封装到UserDTO中,最后返回。其中,由于select与from拆分了以后返回的泛型类型就是Tuple类型(Tuple是一个接口,它可以根据tuple.get(QUser.username)的方式获取User.username的真实值,暂时将他理解为一个类型安全的Map就行),根据pageable参数做了分页处理,fetch之后就返回了一个List<Tuple>对象。从fetch()方法之后,使用到了Stream,紧接着使用Java8的高阶函数map,这个map函数的作用是将List<Tuple>中的Tuple元素依次转换成List<UserDTO>中的UserDTO元素,在这个过程中我们还可以做bean的属性类型转换,将User的Date、Integer类型都转换成String类型。最后,通过collect结束stream,返回一个我们需要的List<UserDTO>。

f、第六个方法与第五个方法的效果相同,使用QueryDSL的Projections实现。但是有一点,当User实体的属性类型与UserDTO中的属性类型不相同时,不方便转换。除了属性类型相同时转换方便以外,还是建议使用map函数进行操作。

g、第七、第八个方法展示了QueryDSL与SpringDataJPA的联合使用,由于我们的UserRepository继承了QueryDslPredicateExecutor,所以获得了联合使用的支持。来看一看QueryDslPredicateExcutor接口的源码:


   
  1. public interface QueryDslPredicateExecutor<T> {
  2. T findOne(Predicate var1);
  3. Iterable<T> findAll(Predicate var1);
  4. Iterable<T> findAll(Predicate var1, Sort var2);
  5. Iterable<T> findAll(Predicate var1, OrderSpecifier... var2);
  6. Iterable<T> findAll(OrderSpecifier... var1);
  7. Page<T> findAll(Predicate var1, Pageable var2);
  8. long count(Predicate var1);
  9. boolean exists(Predicate var1);
  10. }

这里面的方法大多数都是可以传入Predicate类型的参数,说明还是围绕着QUser来进行操作的,如传入quser.username.eq("123")的方式,操作都非常简单。以下是部分源码,请看:


   
  1. /*
  2. * Copyright 2008-2017 the original author or authors.
  3. *
  4. * Licensed under the Apache License, Version 2.0 (the "License");
  5. * you may not use this file except in compliance with the License.
  6. * You may obtain a copy of the License at
  7. *
  8. * http://www.apache.org/licenses/LICENSE-2.0
  9. *
  10. * Unless required by applicable law or agreed to in writing, software
  11. * distributed under the License is distributed on an "AS IS" BASIS,
  12. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13. * See the License for the specific language governing permissions and
  14. * limitations under the License.
  15. */
  16. package org.springframework.data.jpa.repository.support;
  17. import java.io.Serializable;
  18. import java.util.List;
  19. import java.util.Map.Entry;
  20. import javax.persistence.EntityManager;
  21. import javax.persistence.LockModeType;
  22. import org.springframework.data.domain.Page;
  23. import org.springframework.data.domain.Pageable;
  24. import org.springframework.data.domain.Sort;
  25. import org.springframework.data.querydsl.EntityPathResolver;
  26. import org.springframework.data.querydsl.QSort;
  27. import org.springframework.data.querydsl.QueryDslPredicateExecutor;
  28. import org.springframework.data.querydsl.SimpleEntityPathResolver;
  29. import org.springframework.data.repository.support.PageableExecutionUtils;
  30. import org.springframework.data.repository.support.PageableExecutionUtils.TotalSupplier;
  31. import com.querydsl.core.types.EntityPath;
  32. import com.querydsl.core.types.OrderSpecifier;
  33. import com.querydsl.core.types.Predicate;
  34. import com.querydsl.core.types.dsl.PathBuilder;
  35. import com.querydsl.jpa.JPQLQuery;
  36. import com.querydsl.jpa.impl.AbstractJPAQuery;
  37. /**
  38. * QueryDsl specific extension of {@link SimpleJpaRepository} which adds implementation for
  39. * {@link QueryDslPredicateExecutor}.
  40. *
  41. * @author Oliver Gierke
  42. * @author Thomas Darimont
  43. * @author Mark Paluch
  44. * @author Jocelyn Ntakpe
  45. * @author Christoph Strobl
  46. */
  47. public class QueryDslJpaRepository<T, ID extends Serializable> extends SimpleJpaRepository<T, ID>
  48. implements QueryDslPredicateExecutor< T> {
  49. private static final EntityPathResolver DEFAULT_ENTITY_PATH_RESOLVER = SimpleEntityPathResolver.INSTANCE;
  50. private final EntityPath<T> path;
  51. private final PathBuilder<T> builder;
  52. private final Querydsl querydsl;
  53. /**
  54. * Creates a new {@link QueryDslJpaRepository} from the given domain class and {@link EntityManager}. This will use
  55. * the {@link SimpleEntityPathResolver} to translate the given domain class into an {@link EntityPath}.
  56. *
  57. * @param entityInformation must not be {@literal null}.
  58. * @param entityManager must not be {@literal null}.
  59. */
  60. public QueryDslJpaRepository(JpaEntityInformation<T, ID> entityInformation, EntityManager entityManager) {
  61. this(entityInformation, entityManager, DEFAULT_ENTITY_PATH_RESOLVER);
  62. }
  63. ...............
  64. ............

至于源码,感兴趣的同学可以自行跟踪研究。

h、最后,我们的杀手锏来了,JPA对动态条件拼接查询支持一向都不太灵活,如果在mybatis中,我们使用if标签可以很容易的实现动态查询,但是在JPA中,就没有那么方便了。SpringDataJPA给我们提供了Specification+JpaSpecificationExecutor帮我们解决,但是,在需要编写某些复杂的动态条件拼接、分组之后又动态拼接的复杂查询,可能就显得力不从心了,这个时候可能需要直接对entityManager操作,然后对sql进行拼接,请看以下老代码是怎么写的


   
  1. //自定义动态报表原生sql查询
  2. //只要isSelect不为空,那么就执行条件查询:前端自行根据返回值判断是否已经选题(大于0就是选了题的)
  3. public Page<StudentToAdminVO> findAllStudentToAdminVOPage(Pageable pageable, String majorId, Boolean isSelect, Boolean isSelectSuccess) {
  4. //设置条件
  5. StringBuffer where = new StringBuffer( " where 1=1 ");
  6. StringBuffer having = new StringBuffer( " having 1=1");
  7. if(!StringUtils.isEmpty(majorId)){
  8. where.append( " and s.major_id=:majorId ");
  9. }
  10. if(isSelect!= null){
  11. //是否选题了,只需要看查出的这个数是否大于零即可
  12. if(isSelect)
  13. having.append( " and count(se.id)>0 ");
  14. else
  15. having.append( " and count(se.id)=0 ");
  16. }
  17. if(isSelectSuccess != null){
  18. if(isSelectSuccess)
  19. having.append( " and max(se.is_select)>0");
  20. else
  21. having.append( " and (max(se.is_select) is null or max(se.is_select)<=0)");
  22. }
  23. //主体sql
  24. String sql = "select s.id, s.username, s.nickname, s.sclass, m.name majorName, count(se.id) as choose, max(se.is_select) as selectSuccess from student s"
  25. + " left join selection se on s.id=se.student_id "
  26. + " left join major m on m.id=s.major_id "
  27. + where
  28. + " group by s.id"
  29. + having;
  30. String countSql = null;
  31. //计算总记录数sql
  32. if(isSelect!= null){
  33. countSql = "select count(*) from student s "
  34. + where
  35. + " and s.id in(select ss.id FROM student ss left join selection se on se.student_id=ss.id GROUP BY ss.id "
  36. + having
  37. + " )";
  38. } else{
  39. countSql = "select count(*) from student s " + where;
  40. }
  41. //创建原生查询
  42. Query query = em.createNativeQuery(sql);
  43. Query countQuery = em.createNativeQuery(countSql);
  44. if(!StringUtils.isEmpty(majorId)){
  45. query.setParameter( "majorId", majorId);
  46. countQuery.setParameter( "majorId", majorId);
  47. }
  48. int total = Integer.valueOf(countQuery.getSingleResult().toString());
  49. // pageable.getPageNumber()==0 ? pageable.getOffset() : pageable.getOffset()-5
  50. if(pageable!= null){
  51. query.setFirstResult(pageable.getOffset());
  52. query.setMaxResults(pageable.getPageSize());
  53. }
  54. //对象映射
  55. query.unwrap(SQLQuery.class)
  56. .addScalar( "id", StandardBasicTypes.STRING)
  57. .addScalar( "username", StandardBasicTypes.STRING)
  58. .addScalar( "nickname", StandardBasicTypes.STRING)
  59. .addScalar( "sclass", StandardBasicTypes.STRING)
  60. .addScalar( "majorName", StandardBasicTypes.STRING)
  61. .addScalar( "choose", StandardBasicTypes.INTEGER)
  62. .addScalar( "selectSuccess", StandardBasicTypes.INTEGER)
  63. .setResultTransformer(Transformers.aliasToBean(StudentToAdminVO.class));
  64. return new PageImpl<StudentToAdminVO>(query.getResultList(), pageable, total);
  65. }

我们再来看一个对JPQL拼接的例子:


   
  1. /**
  2. * 动态查询
  3. * @param pageable
  4. * @param isSelect 是否确选(只要非空,都相当于加了条件)
  5. * @param titleLike 根据title模糊查询
  6. * @param teacherId 根据老师的id查询
  7. * @return
  8. */
  9. Page<SubjectToTeacherVO> findAllSubjectToTeacherVO(Pageable pageable, Boolean isSelect, String titleLike,
  10. String teacherId, String majorId, String studentId){
  11. //条件组合
  12. StringBuffer where = new StringBuffer( " where 1=1 ");
  13. StringBuffer having = new StringBuffer();
  14. if(isSelect != null){
  15. if(isSelect)
  16. having.append( " having max(se.isSelection)>0 ");
  17. else
  18. having.append( " having ((max(se.isSelection) is null) or max(se.isSelection)<=0) ");
  19. }
  20. if(!StringUtils.isEmpty(titleLike))
  21. where.append( " and su.title like :titleLike");
  22. if(!StringUtils.isEmpty(teacherId))
  23. where.append( " and su.teacher.id=:teacherId");
  24. if(!StringUtils.isEmpty(majorId))
  25. where.append( " and su.major.id=:majorId");
  26. if(!StringUtils.isEmpty(studentId)){
  27. where.append( " and su.major.id=(select stu.major.id from Student stu where stu.id=:studentId)");
  28. }
  29. //主jpql 由于不能使用 if(exp1,rsul1,rsul2)只能用case when exp1 then rsul1 else rsul2 end
  30. String jpql = "select new cn.edu.glut.vo.SubjectToTeacherVO(su.id, su.title, cast(count(se.id) as int) as guysNum, max(se.isSelection) as choose, "
  31. + " (select ss.nickname from Selection as sel left join sel.student as ss where sel.subject.id=su.id and sel.isSelection=1) as stuName, "
  32. + " (select t.nickname from Teacher t where t.id=su.teacher.id) as teacherName, "
  33. + " ma.id as majorId, ma.name as majorName) "
  34. + " from Subject as su left join su.selections as se"
  35. + " left join su.major as ma "
  36. + where
  37. + " group by su.id "
  38. + having;
  39. String countJpql = null;
  40. if(isSelect != null)
  41. countJpql = "select count(*) from Subject su left join su.selections as se left join se.student as s"
  42. + where
  43. + " and su.id in(select s.id from Subject s left join s.selections se group by s.id "
  44. + having
  45. + " )";
  46. else
  47. countJpql = "select count(*) from Subject su left join su.selections as se left join se.student as s" + where;
  48. Query query = em.createQuery(jpql, SubjectToTeacherVO.class);
  49. Query countQuery = em.createQuery(countJpql);
  50. // pageable.getPageNumber()==0 ? pageable.getOffset() : pageable.getOffset()-5
  51. if( null != pageable){
  52. query.setFirstResult(pageable.getOffset());
  53. query.setMaxResults(pageable.getPageSize());
  54. }
  55. if(!StringUtils.isEmpty(titleLike)){
  56. query.setParameter( "titleLike", "%"+titleLike+ "%");
  57. countQuery.setParameter( "titleLike", "%"+titleLike+ "%");
  58. }
  59. if(!StringUtils.isEmpty(teacherId)){
  60. query.setParameter( "teacherId", teacherId);
  61. countQuery.setParameter( "teacherId", teacherId);
  62. }
  63. if(!StringUtils.isEmpty(majorId)){
  64. query.setParameter( "majorId", majorId);
  65. countQuery.setParameter( "majorId", majorId);
  66. }
  67. if(!StringUtils.isEmpty(studentId)){
  68. query.setParameter( "studentId", studentId);
  69. countQuery.setParameter( "studentId", studentId);
  70. }
  71. List<SubjectToTeacherVO> voList = query.getResultList();
  72. return new PageImpl<SubjectToTeacherVO>(voList, pageable, Integer.valueOf(countQuery.getSingleResult().toString()));
  73. }

说恶心一点都不过分...不知道小伙伴们觉得如何,反正我是忍不了了...

我们UserService中的最后两个方法就是展示如何做动态查询的,第一个方法结合了与SpringDataJPA整合QueryDSL的findAll来实现,第二个方法使用QueryDSL本身的API进行实现,其中Page是Spring自身的的。第一行user.isNotNull.or(user.isNull())可以做到类似where 1=1的效果以便于后面进行的拼接,当然,主键是不能为空的,所以此处也可以只写user.isNotNull()也可以。紧接着是一串的三目运算符表达式,以第一行三目表达式为例,表达意义在于:如果用户名为空,就返回定义好的predicate;如果不为空,就使用ExpressionUtils的and方法将username作为条件进行组合,ExpressionUtils的and方法返回值也是一个Predicate。下面的几条三目运算符与第一条是类似的。最后使用findAll方法传入分页参数与条件参数predicate,相比起上面头疼的自己拼接,是不是简洁了很多?

最后一个方法展示的是如果有分组条件时进行的查询,相信大家就字面意思理解也能知道大概的意思了,前半部分代码是相同的,groupby之后需要插入条件是要用到having的。就与sql的规范一样,如果对分组与having还不了解,希望大家多多google哦。

2.2.2 多表使用

对于多表使用,大致与单表类似。我们先创建一个一对多的关系,一个部门对应有多个用户,创建Department实体:


   
  1. @Data
  2. @Entity
  3. @Table(name = "t_department")
  4. public class Department {
  5. @Id
  6. @GeneratedValue(strategy = GenerationType.IDENTITY)
  7. private Integer deptId; //部门id
  8. private String deptName; //部门名称
  9. private Date createDate; //创建时间
  10. }

在User实体需要稍稍修改,User实体中添加department建模:


   
  1. @Data
  2. @Entity
  3. @Table(name = "t_user")
  4. public class User {
  5. @Id
  6. @GeneratedValue(strategy = GenerationType.IDENTITY)
  7. private Integer userId;
  8. private String username;
  9. private String password;
  10. private String nickName;
  11. private Date birthday;
  12. private BigDecimal uIndex; //排序号
  13. //一对多映射
  14. @ManyToOne(cascade = CascadeType.MERGE, fetch = FetchType.EAGER)
  15. @JoinColumn(name = "department_id")
  16. private Department department; //部门实体
  17. }

我们假设有一个这样的需求,前端需要展示根据部门deptId来查询用户的基础信息,在展示用户基础信息的同时需要展示该用户所属的部门名称以及该部门创建的时间。那么,我们创建一个这样的DTO来满足前端的需求:


   
  1. @Data
  2. @Builder
  3. public class UserDeptDTO {
  4. //用户基础信息
  5. private String username; //用户名
  6. private String nickname; //昵称
  7. private String birthday; //用户生日
  8. //用户的部门信息
  9. private String deptName; //用户所属部门
  10. private String deptBirth; //部门创建的时间
  11. }

大家一定想到了使用部分字段映射的投影查询,接下来我们在UserService中添加如下代码:


   
  1. /**
  2. * 根据部门的id查询用户的基本信息+用户所属部门信息,并且使用UserDeptDTO进行封装返回给前端展示
  3. * @param departmentId
  4. * @return
  5. */
  6. public List<UserDeptDTO> findByDepatmentIdDTO(int departmentId) {
  7. QUser user = QUser.user;
  8. QDepartment department = QDepartment.department;
  9. //直接返回
  10. return jpaQueryFactory
  11. //投影只去部分字段
  12. .select(
  13. user.username,
  14. user.nickName,
  15. user.birthday,
  16. department.deptName,
  17. department.createDate
  18. )
  19. .from(user)
  20. //联合查询
  21. .join(user.department, department)
  22. .where(department.deptId.eq(departmentId))
  23. .fetch()
  24. //lambda开始
  25. .stream()
  26. .map(tuple ->
  27. //需要做类型转换,所以使用map函数非常适合
  28. UserDeptDTO.builder()
  29. .username(tuple.get(user.username))
  30. .nickname(tuple.get(user.nickName))
  31. .birthday( new SimpleDateFormat( "yyyy-MM-dd HH:mm:ss").format(tuple.get(user.birthday)))
  32. .deptName(tuple.get(department.deptName))
  33. .deptBirth( new SimpleDateFormat( "yyyy-MM-dd HH:mm:ss").format(tuple.get(department.createDate)))
  34. .build()
  35. )
  36. .collect(Collectors.toList());
  37. }

select部分是选择需要查询的字段,leftjoin的第一个参数是用户所关联的部门,第二个参数可以当做该user.department别名来使用,往后看即可理解。where中只有一个很简单的条件,即根据部门的id来进行查询,最后使用stream来将Tuple转换成UserDeptDTO,中间在map函数中对一些属性的类型进行了转换。其他的关联操作与上述代码类似,对于orderBy、groupBy、聚合函数、分页操作的API都与单表的类似,只是where中的条件自己进行适配即可。

在应用开发中我们可能不会在代码中设置@ManyToOne、@ManyToMany这种类型的“强建模”,而是在随从的Entity中仅仅声明一个外键属性,比如User实体的下面代码,只是添加了一个departmentId:


   
  1. @Data
  2. @Entity
  3. @Table(name = "t_user")
  4. public class User {
  5. @Id
  6. @GeneratedValue(strategy = GenerationType.IDENTITY)
  7. private Integer userId;
  8. private String username;
  9. private String password;
  10. private String nickName;
  11. private Date birthday;
  12. private BigDecimal uIndex; //排序号
  13. private Integer departmentId;
  14. }

这时候我们的多表关联业务代码只需要稍作修改就可以:


   
  1. /**
  2. * 根据部门的id查询用户的基本信息+用户所属部门信息,并且使用UserDeptDTO进行封装返回给前端展示
  3. *
  4. * @param departmentId
  5. * @return
  6. */
  7. public List<UserDeptDTO> findByDepatmentIdDTO(int departmentId) {
  8. QUser user = QUser.user;
  9. QDepartment department = QDepartment.department;
  10. //直接返回
  11. return jpaQueryFactory
  12. //投影只去部分字段
  13. .select(
  14. user.username,
  15. user.nickName,
  16. user.birthday,
  17. department.deptName,
  18. department.createDate
  19. )
  20. .from(user, department)
  21. //联合查询
  22. .where(
  23. user.departmentId.eq(department.deptId).and(department.deptId.eq(departmentId))
  24. )
  25. .fetch()
  26. //lambda开始
  27. .stream()
  28. .map(tuple ->
  29. //需要做类型转换,所以使用map函数非常适合
  30. UserDeptDTO.builder()
  31. .username(tuple.get(user.username))
  32. .nickname(tuple.get(user.nickName))
  33. .birthday( new SimpleDateFormat( "yyyy-MM-dd HH:mm:ss").format(tuple.get(user.birthday)))
  34. .deptName(tuple.get(department.deptName))
  35. .deptBirth( new SimpleDateFormat( "yyyy-MM-dd HH:mm:ss").format(tuple.get(department.createDate)))
  36. .build()
  37. )
  38. .collect(Collectors.toList());
  39. }

我们在from中多加了department参数,在where中多加了一个user.department.eq(department.deptId)条件,与sql中的操作类似。为什么在这里不适用join....on....呢,原因是我们使用的是QueryDSL-JPA,QueryDSL对JPA支持是全面的,当然也有QueryDSL-SQL,但是配置起来会比较麻烦。如果大家想了解QueryDSL-SQL可以点击这里进行了解。

3 结语

  使用SpringDataJPA能够解决我们大多数问题,但是在处理复杂条件、动态条件、投影查询时可能QueryDSL JPA更加直观,而且SpringDataJPA对QueryDSL有着非常好的支持,SpringDataJPA+QueryDSL在我眼里看来是天生一对,互相补漏。在使用一般查询、能够满足基础条件的查询我们使用SpringDataJPA更加简洁方便,当遇到复杂、投影、动态查询时我们可以考虑使用QueryDSL做开发。以上方案可以解决大多数持久层开发问题,当然,如果问题特别刁钻,还是不能满足你的需求,你也可以考虑直接操作HQL或者SQL。

  今天的分享就到此结束了,小伙伴们如果有更好的建议,欢迎大家提出指正,但是请不要谩骂与辱骂,写一篇博客实属不易。

原文地址:https://blog.csdn.net/phapha1996/article/details/83614975
发布评论
IT序号网

微信公众号号:IT虾米 (左侧二维码扫一扫)欢迎添加!

springboot2.x整合JPA知识解答
你是第一个吃螃蟹的人
发表评论

◎欢迎参与讨论,请在这里发表您的看法、交流您的观点。