SpringBoot JPA实践之EntityManage查询返回自定义DTO

 

 

在很多时候我更喜欢随意组合查询出来返回一个DTO对象的实现，JPA提供的多数查询均以返回Entity居多，它提供的EntityManager对象可以实现将SQL语句查询的结果转换为自定义DTO对象（这与@Query注解查询返回接口结果集相似），本篇文章围绕不使用任何Entity与对象级联配置的情况，将原生SQL查询的结果集转换为自定义DTO对象。

参考代码

package cn.chendd.example.jpa.user.dao;

/**
 * @author chendd
 * @date 2020/5/5 22:26
 */
@Repository
@Transactional(readOnly = true)
public class UserQueryCustomResultDao {

    @PersistenceContext
    private EntityManager entityManager;

    public List<Map<String , Object>> nativeSqlQuery2Map() {
        String sql = "select 7 age , 3.1415 pi , name userName , createTime createTime " +
                " from user a where a.name = ?";
        NativeQueryImpl query = entityManager.createNativeQuery(sql).unwrap(NativeQueryImpl.class);
        query.setParameter(1, "chendd");
        query.setResultTransformer(Transformers.ALIAS_TO_ENTITY_MAP);
        List<Map<String, Object>> resultList = query.getResultList();
        return resultList;
    }

    public List<UserResultDto> nativeSqlQuery2Bean() {
        String sql = "select id, name userName , createTime , 3.1415 pi , 100.00 amount , 1 status" +
                " from user a where a.name = ?";
        NativeQueryImpl query = entityManager.createNativeQuery(sql).unwrap(NativeQueryImpl.class);
        query.setResultTransformer(Transformers.aliasToBean(UserResultDto.class));
        query.setParameter(1, "chendd");
        query.addScalar("id", StandardBasicTypes.STRING);
        query.addScalar("userName", StandardBasicTypes.STRING);
        query.addScalar("createTime", StandardBasicTypes.TIMESTAMP);
        query.addScalar("pi", StandardBasicTypes.DOUBLE);
        query.addScalar("amount", StandardBasicTypes.BIG_DECIMAL);
        /*query.addScalar("status", StandardBasicTypes.NUMERIC_BOOLEAN);*/
        query.addScalar("status" , StandardBasicTypes.BOOLEAN);
        List<UserResultDto> resultList = query.getResultList();
        return resultList;
    }

}

代码剖析

（1）核心查询使用EntityManager对象的createNativeQuery方法实现；

（2）unwrap函数可以构建多种多样的类型，使用返回NativeQueryImpl的实现类进行SQL查询，当前类或方法的事物必须为只读，只有设置了事物Transactional为只读时，才可正常范围该实现类，否则返回为Proxy类；

（3）Transformers.ALIAS_TO_ENTITY_MAP将集合泛型类型转换为Map类型，默认为Array类型；

（4）Transformers.aliasToBean指定查询集合泛型类型为自定义DTO类型，但必须设置所有参数对应的StandardBasicTypes对应类型；

（5）getResultList、list返回为List类型，singleResult返回为单条数据对象，几乎所有的框架组件实现在查询返回为Map（Single）类型结构的时候需要保证数据可以查询到，并且查询到仅为1条，否则抛出异常；

@2020/10/27

经过稍微深入一些的案例分析（以oracle为例），发现上述代码函数“nativeSqlQuery2Bean”中的处理字段别名映射部分，可以不通过addScalar函数去设置需要映射的字段参数类型，如果了解的话（或者是明确的话）直接将参数列绑定到一个普通的DTO对象中的某个属性字段上。

注意：

（1）当SQL语句有select 1 "a" , 2 "c" from dual这种时，由于当前查询的dual是一个虚拟数据，理论上讲这里查询的数据库中的数字类型number一律映射为DTO中的BigDecimal类型，无论数据库中返回的是否包含小数点之类的。

（2）不使用addScalar指定时，必须严格根据字段类型的限制，否则会报错；