springboot jpa之返回表中部分字段的處理詳解

Posted on by

springboot jpa返回表中部分字段

使用springboot jpa操作數據庫可以加快我們的開發效率，對於簡單的crud操作來說，使用jpa來開發不要太爽，但是說實話對於一些復雜的數據庫操做jpa使用起來就不是這麼爽瞭。

在開發中很多時候我們要返回的可能隻是數據庫表中或某個類中的一部分字段，這個要是用mybatis的話就很簡單，直接在sql中select字段就好瞭，規范一點就數據傳輸類接一下，偷個懶的話直接用map接就完事瞭。但就是這麼個小操作在jpa中就不能這麼直接。

廢話一大堆(⊙_⊙)下面是我在jpa中處理返回部分字段的方法。

/**
 * 房間已經預定的時間統計表
 */
public interface RoomOrderTimeRepository extends JpaRepository<RoomOrderTime,Integer>{ 
    @Query("select  new com.ddzrh.dto.RoomOrderTimeOutPut(r.orderTime,COUNT(r.orderTime) )" +
            " from RoomOrderTime as r " +
            " where r.roomTypeId =:roomId"+
            " GROUP BY r.orderTime" )
    List<RoomOrderTimeOutPut> queryRoomOrderTime(@Param("roomId") Integer roomId);  
}

看完上面的代碼相比大傢也能猜到，是的沒什麼好方法，我將要返回的數據都封裝到瞭RoomOrderTimeOutPut類中。

@Data
public class RoomOrderTimeOutPut { 
    private Date orderTime;
    private Long orderNum; 
    public RoomOrderTimeOutPut(Date orderTime, Long orderNum) {
        this.orderTime = orderTime;
        this.orderNum = orderNum;
    }    
}

像上面的代碼，我希望查詢返回某個時間某間房的預定數，我就將希望返回的預定時間和預定數封裝至RoomOrderTimeOutPut並寫以這兩個字段為入參的構造函數，這個構造函數一定要寫。看Query中的sql 有一個new RoomOrderTimeOutPut 的操作，這裡就調用瞭構造函數，根據構造函數的入參將數據庫查出的值傳入。

jpa 自定義返回字段

實體類：User.java

@Data
@Accessors(chain = true)
@EqualsAndHashCode(callSuper = true)
@Entity
@Table(name = "user")
public class User extends AbstractEntity { 
    @Column(unique = true)
    private String username; 
    private String password; 
    private String nickname; 
    private String email; 
    @Column(name = "org_id")
    private Long orgId; 
    @Column(name = "org_name")
    private String orgName;
}

DTO類：UserDTO.java

import lombok.Value; 
/**
 * @author wu qilong
 * @date 2019/4/11
 * @Description: 自定義返回值，字段名稱要和User實體類中的一致，加上lombok.@Value註解。
 */
@Value
public class UserDTO { 
    private String username; 
    private String nickname; 
    private String email;
}

repository類：UserRepository.java

/**
 * @author Wu Qilong
 * @date 2019/4/11
 * @Description:
 */
public interface UserRepository extends JpaRepository<User, Long> {
 
    /**
     * 用戶名查詢
     *
     * @param username
     * @return
     */
    Optional<User> findByUsername(String username);
 
 
    /**
     * 用戶名查詢
     * @param username
     * @return
     */
    <T> Optional<T> findByUsername(String username, Class<T> type);
}

測試：

@RunWith(SpringRunner.class)
@SpringBootTest
public class UoServerApplicationTests { 
    @Autowired
    UserRepository userRepository; 
    @Test
    public void contextLoads() {
        UserDTO userDTO = userRepository.findByUsername("wuqilong", UserDTO.class).get();
        Console.log(userDTO);
    }
}

註意：返回的DTO中屬性名稱需要和實體類中字段名一致，且加上lombok包中的@Value註解，這種方式對於隻需要返回表中部分的字段很方便，如果需要自定義返回字段名稱，可以參考以下方法：

需求：統計註冊人數

定義一個返回對象

使用@Query(value = “select new com.wd.cloud.uoserver.dto.TjVO(u.orgId ,count(u.orgId)) from User u group by orgId”)進行查詢。

@Value
public class TjVO { 
    Long orgId; 
    Long registerCount;
}
/**
     * 按機構統計註冊人數
     * @param pageable
     * @return
     */
    @Query(value = "select new com.wd.cloud.uoserver.dto.TjVO(u.orgId ,count(u.orgId)) from User u group by orgId")
    Page<TjVO> tjByOrgId(Pageable pageable);

或者也可以用下面的方法：

定義一個接口，用getXxx定義返回字段。xxx需要和返回字段的別名一致。

如果不一致，可以使用org.springframework.beans.factory.annotation包中的@Value進行映射

public interface TjDTO { 
    /**
     * 所屬機構
     * @return
     */
    Long getOrgId();
    /**
     * 註冊時間
     * @return
     */
    String getRegisterDate();
 
    /**
     * 註冊數量
     * @return
     */
    String getRegisterCount();
 
    /**
     * 管理員數量 當別名與該getXXX名稱不一致時，可以使用該註解調整
     * @return
     */
    @Value("#{target.adminCount}")
    Long getManagerCount(); 
}

repository類：UserRepository.java添加方法tjByOrgId(),返回orgId和registerCount

 /**
     * 按天統計註冊人數
     * @return
     */
    @Query(value = "select DATE_FORMAT(gmt_create,\"%Y-%m-%d\") as registerDate,count(*) as registerCount from user group by registerDate",nativeQuery = true)
    List<TjDTO> tj();
 
    /**
     * 按機構統計註冊人數
     * @param pageable  分頁
     * @return
     */
    @Query(value = "select org_id as orgId,count(*) as registerCount from user group by orgId",
            countQuery = "select count(*) from user group by org_id", nativeQuery = true)
    Page<TjDTO> tjByOrgId(Pageable pageable);

測試：

@RunWith(SpringRunner.class)
@SpringBootTest
public class UoServerApplicationTests { 
    @Autowired
    UserRepository userRepository; 
    @Test
    public void contextLoads() {
        List<TjDTO> tjDTOList = userRepository.tj();
        tjDTOList.forEach(tjDTO -> {
            Console.log("registerDate={},registerCount={}", tjDTO.getRegisterDate(), tjDTO.getRegisterCount());
        });
    }
}

結果日志：

Hibernate: select DATE_FORMAT(gmt_create,”%Y-%m-%d”) as registerDate,count(*) >as registerCount from user group by registerDate
registerDate=2019-01-28,registerCount=7393
registerDate=2019-03-07,registerCount=1

需求：根據機構分組，統計機構總人數和用戶類型為2的人數

@Component
public class SpecBuilder { 
    @PersistenceContext
    private EntityManager entityManager; 
    public List<Object[]> tj(Long orgId) {
        CriteriaBuilder cb = entityManager.getCriteriaBuilder();
        CriteriaQuery<Object[]> query = cb.createQuery(Object[].class);
        Root<User> root = query.from(User.class);
        //拼接where條件
        List<Predicate> predicateList = new ArrayList<Predicate>();
        if (orgId != null) {
            predicateList.add(cb.equal(root.get("orgId"), orgId));
        }
        //加上where條件
        query.where(ArrayUtil.toArray(predicateList, Predicate.class));
        query.multiselect(root.get("orgId"),
                cb.count(root),
                cb.sum(cb.<Integer>selectCase().when(cb.equal(root.get("userType"), 2), 1).otherwise(0)));
        query.groupBy(root.get("orgId"));
        //最終sql:  select org_id,count(id),sum(case when user_type=2 then 1 else 0 end) from user where org_id=?1 group by org_id;
        TypedQuery<Object[]> typedQuery = entityManager.createQuery(query);
        return typedQuery.getResultList();
    } 
}

測試：

@RunWith(SpringRunner.class)
@SpringBootTest
public class UoServerApplicationTests { 
    @Autowired
    SpecBuilder specBuilder;
 
    @Test
    public void contextLoads() {
        List<Object[]> tjDTOList1 = specBuilder.tj(169L);
        tjDTOList1.forEach(tjDTO -> {
            Console.log("orgId={},總人數={},管理員人數={}", tjDTO[0], tjDTO[1], tjDTO[2]);
        });
    }
}

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。

推薦閱讀：