转载

JPQ整合Querydsl入门篇

不知道你们喜不喜欢用JPA ，我本人是很喜欢不要和我说JPA不适合复杂查询等等的，你要知道现在都是微服务，只要你服务器拆分够细表设计够合理，都是服务之间调能用到多少关联查询呢？而且结合了QueryDsl工具让你写起来更快，本博客后台就是使用了JPA+QueryDsl 做的查询下面开始讲解吧。

1.为什么要用QueryDsl

先来看个代码

@Override
public List<Object[]> findByPcardCardOrder(
        PcardCardOrder pcardCardOrder,String applyInstName2,Integer page, Integer rows) {
    StringBuffer sql = new StringBuffer(
            "SELECT p.*"
                    +",p2.vcard_make_des" 
                    +",p3.cardnum_rule_id,p3.vtype_nm"
                    +",p4.cn_card_bin,p4.cn_nm"
                    +",p5.inst_id,p5.inst_name,p5.apply_range,p5.card_name,p5.card_type,p5.bin_card_material"
                    +",p6.inst_name AS apply_inst_name "
                    +",p7.inst_name AS apply_inst_name2"
                    + ",p8.inst_name as receive_inst_name"
                    + " FROM "
                    +" tbl_pcard_card_order p LEFT JOIN tbl_pcard_vcard_make p2 ON p.make_id = p2.vcard_make_id"
                 +" LEFT JOIN  tbl_pcard_vtype p3 ON p2.vcard_make_vtype_id=p3.vtype_id"
                 +" LEFT JOIN  tbl_pcard_cardnum_rule p4 ON p3.cardnum_rule_id=p4.cn_id"
                 +" LEFT JOIN  tbl_pcard_cardbin p5 ON p4.cn_card_bin=p5.card_bin"
                 +" LEFT JOIN  tbl_pcard_institution p6 ON p5.apply_range=p6.inst_id"
                 +" LEFT JOIN  tbl_pcard_institution p7 ON p.apply_inst_id=p7.inst_id"
                 +" LEFT JOIN  tbl_pcard_institution p8 ON p.receive_inst=p8.inst_id"
                 +" WHERE 1=1 ");
    int i = 1;
    Map<String, Object> map = new HashMap<String, Object>();

    if (!StringUtils.isEmpty(pcardCardOrder.getCordId())) {
        sql.append(" and p.cord_id=");
        sql.append("?" + i);
        map.put(i + "", pcardCardOrder.getCordId());
        i++;
    }
    if (!StringUtils.isEmpty(pcardCardOrder.getAppointMchtcard())) {
        sql.append(" and p.appoint_mchtcard=");
        sql.append("?" + i);
        map.put(i + "", pcardCardOrder.getAppointMchtcard());
        i++;
    }

    if (!StringUtils.isEmpty(pcardCardOrder.getMakeId())) {
        sql.append(" and p.make_id like ");
        sql.append("?" + i);
        map.put(i + "","%%"+ pcardCardOrder.getMakeId()+"%%");
        i++;
    }

    if (!StringUtils.isEmpty(applyInstName2)) {
        sql.append(" and p7.inst_name like ");
        sql.append("?"+i);
        map.put(i+"","%%"+applyInstName2+"%%");
        i++;
    }
    
    sql.append(" order by p.ct_dm desc");
    Query query = entityManager.createNativeQuery(sql.toString());
    for (String key : map.keySet()) {
        query.setParameter(key, map.get(key));
    }
    if (page != null && rows != null) {
        query.setFirstResult(rows * (page - 1));
        query.setMaxResults(rows);
    }
    return query.getResultList();
}

多的不用说了吧，我看到这种代码就想吐也没心情看，说真的这个还算好的了，还见过更多更恶心的

2.了解QueryDsl

QueryDsl官网文档

QueryDSL仅仅是一个通用的查询框架，专注于通过Java API构建类型安全的SQL查询。

Querydsl可以通过一组通用的查询API为用户构建出适合不同类型ORM框架或者是SQL的查询语句，也就是说QueryDSL是基于各种ORM框架以及SQL之上的一个通用的查询框架。

借助QueryDSL可以在任何支持的ORM框架或者SQL平台上以一种通用的API方式来构建查询。目前QueryDSL支持的平台包括JPA,JDO,SQL,Mongodb 等等。。。

3.引入QueryDsl

3.1 pom中引入依赖

<!-- querydsl -->
    <dependency>
        <groupId>com.querydsl</groupId>
        <artifactId>querydsl-jpa</artifactId>
    </dependency>
    <dependency>
        <groupId>com.querydsl</groupId>
        <artifactId>querydsl-apt</artifactId>
        <scope>provided</scope>
    </dependency>

3.2 添加maven插件

添加这个插件是为了让程序自动生成query type(查询实体，命名方式为："Q"+对应实体名)。

注：在使用过程中,如果遇到query type无法自动生成的情况，用maven更新一下项目即可解决(右键项目->Maven->Update Project)，或者之间终端输入 mvn clean compile 编译一下就会自动生成Q 类

<plugin>
            <groupId>com.mysema.maven</groupId>
            <artifactId>apt-maven-plugin</artifactId>
            <version>1.1.3</version>
            <executions>
                <execution>
                    <goals>
                        <goal>process</goal>
                    </goals>
                    <configuration>
                        <outputDirectory>target/generated-sources/java</outputDirectory>
                        <processor>com.querydsl.apt.jpa.JPAAnnotationProcessor</processor>
                    </configuration>
                </execution>
            </executions>
        </plugin>

3.3 JPA的基本配置，在application.yml中配置

spring：
 jpa:
  database: mysql
  show-sql: true
  open-in-view: true
  hibernate:
   ddl-auto: update
   naming:
    strategy: org.hibernate.cfg.DefaultComponentSafeNamingStrategy
  properties:
   hibernate:
    dialect: org.hibernate.dialect.MySQL5InnoDBDialect
    format_sql: true

3.4 创建实体

这里只是列出了部分属性

@Data
@Entity

@EntityListeners(AuditingEntityListener.class)
public class BlogInfo {

  @Id
  @GeneratedValue(strategy = GenerationType.IDENTITY)
  private Long id;

  /**
   * 博客标题
   */
  private String blogTitle;
  /**
   * 博客内容
   */
  @Column(columnDefinition = "text")
  private String blogContent;

  /**
   * 博客简要
   */
  private String blogShortContent;
}

3.5 引入JPAQueryFactory

@Service
public class BlogInfoServiceImpl implements BlogInfoService {

private JPAQueryFactory queryFactory;

@PostConstruct  //指定初始化queryFactory 
public void init() {
    queryFactory = new JPAQueryFactory(entityManager);
}

@PersistenceContext
private EntityManager entityManager;
}

4.使用QueryDsl

先定义一个Q类，Q类是QueryDsl帮我们编译的时候生成的对应的是实体类

QBlogInfo qBlogInfo = QBlogInfo.blogInfo;

5. 查询所有属性

通过queryFactory查询
queryFactory.select(qBlogInfo）
    .from(qBlogInfo)  表示查询BlogInfo所有的属性 相当于select * from blog_Info

6.查询特定属性

queryFactory.select(qBlogInfo.blogTitle,qBlogInfo.blogContent） 
    .from(qBlogInfo)  表示查询BlogInfo实体的 blogTitle 属性 相当于 select blogTitle,blogContent from blog_Info

7.带where查询

queryFactory.select(qBlogInfo)
    .from(qBlogInfo)
    .where(qBlogInfo.id.eq(1)) 相当于 select blogTitle from blog_Info where id = 1;

8.多表查询

多表返回Tuple ，tuple.get(0) 就是第一个属性qBlogInfo , tuple.get(1) 就是获取第二个属性 typeName

 queryFactory.select(qBlogInfo, qBlogType.typeName)
        .from(qBlogInfo)
        .leftJoin(qBlogType)
        .on(qBlogInfo.blogTypeId.eq(qBlogType.id))

9.排序查询

追加orderBy方法指定按照什么属性进行排序

queryFactory.select(qBlogInfo）
    .from(qBlogInfo)
    .orderBy（qBlogInfo.createTime.desc()）

10.分页查询

追加offset 偏移位置，就是从哪条数据开始查询

最佳limit 限制查询多少条

JPAQuery jpaQuery = queryFactory.select(qBlogInfo, qBlogType.typeName)
            .from(qBlogInfo)
            .leftJoin(qBlogType)
            .on(qBlogInfo.blogTypeId.eq(qBlogType.id))
            .orderBy(qBlogInfo.createTime.desc())
        .offset(pageable.getPageNumber() * pageable.getPageSize())
            .limit(pageable.getPageSize());

11.执行查询

通过上面构造的 jpaQuery
jpaQuery.fetchResults(); 查询list ，返回 list 泛型根据是否有多表查询，
如果没有就返回 比如上面的QBlogInfo 对应的 BlogInfo ==》 list<BlogInfo>，
如果有多表查询 返回 list<tuple> 类型，再根据tuple.get(0) tuple.get(1) 去获取对应的属性
jpqQuery.fetchOne();  查询单条记录 比如where id = xxx 的时候可以使用

12.样例根据ID查询博客

/**
 * 根据 Id 查询博客信息
 *
 * @param id : id
 * @return : 博客信息
 */
@Override
public BlogInfoVo queryById(Long id) {
    QBlogInfo qBlogInfo = QBlogInfo.blogInfo;

    QBlogType qBlogType = QBlogType.blogType;

    Tuple tuple = queryFactory.select(qBlogInfo, qBlogType.typeName)
            .from(qBlogInfo)
            .leftJoin(qBlogType)
            .on(qBlogInfo.blogTypeId.eq(qBlogType.id))
            .where(qBlogInfo.id.eq(id))
            .fetchOne();

    BlogInfo blogInfo = tuple.get(0, BlogInfo.class);
    Gson gson = new Gson();
    List<Anchor> list = gson.fromJson(blogInfo.getAnchorJson(), List.class);
    BlogInfoVo blogInfoVo = BlogInfoConverter.INSTANCE.domain2vo(tuple.get(0, BlogInfo.class)).setBlogTypeName(tuple.get(1, String.class));
    blogInfoVo.setAnchors(list);
    return blogInfoVo;
}