詳解spring-data-jpa中jpql的投影查詢
投影查詢,就是僅僅檢索表的部分字段。而不是粗暴的 SELECT * FROM...
檢索出所有列數(shù)據(jù)。例如檢索用戶余額信息的時候,就不需要檢索用戶的頭像,創(chuàng)建日期等字段。節(jié)省了帶寬傳輸和內(nèi)存占用,也避免了可能暴露更多數(shù)據(jù)給客戶端。
這里先啰嗦一下jpql的一些注意點
- 操作的是對象 @Entity, 不是表, 操作的是對象屬性, 也不是表字段
- 默認Entity名稱就是類名稱大寫, 也可以通過修改 @Entity 屬性的注解來修改
- 不支持使用 `` 符號, 不支持在末尾添加分號: ;
- 支持使用 AS 關(guān)鍵字起別名
準備一個演示用的實體類
import javax.persistence.*; import java.io.Serializable; import java.time.LocalDateTime; /** * 用戶 */ @Entity @Table(name = "user", indexes = { @Index(columnList = "account", unique = true), }) @org.hibernate.annotations.Table(appliesTo = "user", comment = "用戶") public class User implements Serializable { /** * */ private static final long serialVersionUID = -129586628554861093L; @Id @Column(columnDefinition = "INT(11) UNSIGNED COMMENT 'id'") @GeneratedValue(strategy = GenerationType.IDENTITY) private Integer id; // 登錄賬戶 @Column(columnDefinition = "VARCHAR(20) COMMENT '登錄賬戶'", nullable = false) private String account; // 昵稱 @Column(columnDefinition = "VARCHAR(20) COMMENT '昵稱'") private String name; // 頭像 @Column(columnDefinition = "VARCHAR(255) COMMENT '頭像'") private String avatar; // 創(chuàng)建時間 @Column(name = "created_date", columnDefinition = "timestamp DEFAULT CURRENT_TIMESTAMP COMMENT '創(chuàng)建時間'", nullable = false) private LocalDateTime createdDate; // 最后修改時間 @Column(name = "last_modified_date", columnDefinition = "timestamp NULL DEFAULT NULL COMMENT '最后一次修改時間'") private LocalDateTime lastModifiedDate; // 記錄狀態(tài) @Column(columnDefinition = "TINYINT(1) unsigned COMMENT '是否啟用'", nullable = false) private Boolean enabled; }
檢索單行單列數(shù)據(jù)
單行單列數(shù)據(jù),比較簡單了。返回的列數(shù)據(jù)類型是什么,Repository接口中檢索方法的返回值就定義什么即可。
根據(jù)用戶ID檢索 賬戶字段
public interface UserRepository extends JpaRepository<User, Integer>, JpaSpecificationExecutor <User> { /** * 根據(jù)用戶ID,檢索賬戶信息 * @param id * @return */ @Query("SELECT u.account FROM User AS u WHERE u.id = :id") String accountById(@Param("id") Integer id); }
測試代碼
@Autowired private UserRepository userRepository; @Test @Transactional(readOnly = true) public void test () { String account = userRepository.accountById(1); LOGGER.info("account={}", account); }
執(zhí)行日志
在日志中可以看到執(zhí)行的SQL符合要求,僅僅檢索了一個列,并且返回了正確的結(jié)果。
Hibernate: select user0_.account as col_0_0_ from user user0_ where user0_.id=? o.h.type.descriptor.sql.BasicBinder : binding parameter [1] as [INTEGER] - [1] i.s.jpa.test.JpaApplicationTest : account=KevinBlandy
檢索單行多列數(shù)據(jù)
使用自定義對象 的構(gòu)造器封裝結(jié)果集
自定義一個封裝結(jié)果集的對象
這里直接繼承了User
類,并且需要通過構(gòu)造函數(shù)來定義需要投影檢索的列
import java.time.LocalDateTime; public class UserDTO extends User { /** * */ private static final long serialVersionUID = 6393508321723484097L; public UserDTO(String account, String name, LocalDateTime createdDate) { super.setAccount(account); super.setName(name); super.setCreatedDate(createdDate); } }
根據(jù)檢索出用戶的基本信息:賬戶,昵稱,創(chuàng)建時間,封裝結(jié)果集為UserDTO對象
使用jpql中的NEW
關(guān)鍵字指定自定義對象的全路徑,并且在構(gòu)造函數(shù)中指定要檢索的列,既有sql的語法,又有面向?qū)ο蟮乃枷搿?/p>
/** * 根據(jù)檢索出用戶的基本信息:賬戶,昵稱,創(chuàng)建時間,封裝結(jié)果集為UserDTO對象 * @param id * @return */ @Query("SELECT NEW io.springboot.jpa.entity.UserDTO(u.account, u.name, u.createdDate) FROM User AS u WHERE u.id = :id") UserDTO querySimpleInfoById(@Param("id") Integer id);
測試
@Autowired private UserRepository userRepository; @Test @Transactional(readOnly = true) public void test () { UserDTO userDTO = userRepository.querySimpleInfoById(1); LOGGER.info("user={}", userDTO); }
執(zhí)行日志
Hibernate: select user0_.account as col_0_0_, user0_.name as col_1_0_, user0_.created_date as col_2_0_ from user user0_ where user0_.id=? o.h.type.descriptor.sql.BasicBinder : binding parameter [1] as [INTEGER] - [1] i.s.jpa.test.JpaApplicationTest : user=User [id=null, account=KevinBlandy, name=Vin, avatar=null, createdDate=2020-07-16T10:39:02, lastModifiedDate=null, enabled=null]
使用 Oject[] 封裝結(jié)果集
把結(jié)果集封裝為數(shù)組集合,并不需要重新定義對象,但是缺點就是需要自己記住每個數(shù)組下標下的數(shù)據(jù)代表的是什么 。
根據(jù)檢索出用戶的基本信息:賬戶,昵稱,創(chuàng)建時間,封裝結(jié)果集為Object數(shù)組
/** * 根據(jù)檢索出用戶的基本信息:賬戶,昵稱,創(chuàng)建時間,封裝結(jié)果集為“Object[]” * @param id * @return */ @Query("SELECT u.account, u.name, u.createdDate FROM User AS u WHERE u.id = :id") Object querySimpleInfoById(@Param("id") Integer id);
注意,這里的返回值定義的是Object,而不是想象中的Object[]
,返回值定義為Object[]
,jpa就會把結(jié)果集封裝為一個二維數(shù)組,適合多行多列的情況。
這里演示的是根據(jù)id檢索,只可能是單行,多列。所以定義成Object
,自己強轉(zhuǎn)換一下就好了。
測試
@Autowired private UserRepository userRepository; @Test @Transactional(readOnly = true) public void test () { // 強制轉(zhuǎn)換為Object[] Object[] results = (Object[]) userRepository.querySimpleInfoById(1); for (Object result : results) { LOGGER.info("result={}", result); // 遍歷數(shù)組的所偶結(jié)果 } }
執(zhí)行日志
Hibernate: select user0_.account as col_0_0_, user0_.name as col_1_0_, user0_.created_date as col_2_0_ from user user0_ where user0_.id=? o.h.type.descriptor.sql.BasicBinder : binding parameter [1] as [INTEGER] - [1] i.s.jpa.test.JpaApplicationTest : result=KevinBlandy i.s.jpa.test.JpaApplicationTest : result=Vin i.s.jpa.test.JpaApplicationTest : result=2020-07-16T10:39:02
使用 Map<String, Object> 封裝結(jié)果集
使用map作為結(jié)果集的好處就是,不需要重新定義對象。而且可以根據(jù)key找到自己要的字段。我覺得最方便的一種 方法了,借助于spring的,BeanUtils
,可以把Map轉(zhuǎn)換為對象。
根據(jù)檢索出用戶的基本信息:賬戶,昵稱,創(chuàng)建時間,封裝結(jié)果集為“Map<String, Object>”
/** * 根據(jù)檢索出用戶的基本信息:賬戶,昵稱,創(chuàng)建時間,封裝結(jié)果集為“Map<String, Object>” * @param id * @return */ @Query("SELECT NEW MAP(u.account AS account, u.name AS name, u.createdDate AS createdDate) FROM User AS u WHERE u.id = :id") Map<String, Object> querySimpleInfoById(@Param("id") Integer id);
需要對檢索的列, 使用AS起別名, 作為key的名稱,如果不使用AS別名的話,單行單列的情況下, key = null
, 多行的情況下, key = 序號(從0開始)
{ "0":"Vin", "1":“KevinBlandy” }
測試代碼
@Autowired private UserRepository userRepository; @Test @Transactional(readOnly = true) public void test () { Map<String, Object> result = userRepository.querySimpleInfoById(1); LOGGER.info("result={}", result); }
執(zhí)行日志
Hibernate: select user0_.account as col_0_0_, user0_.name as col_1_0_, user0_.created_date as col_2_0_ from user user0_ where user0_.id=? o.h.type.descriptor.sql.BasicBinder : binding parameter [1] as [INTEGER] - [1] i.s.jpa.test.JpaApplicationTest : result={name=Vin, account=KevinBlandy, createdDate=2020-07-16T10:39:02}
檢索多列N行
對于有多行的記錄封裝,就很簡單了。在上面的基礎(chǔ)上,把返回值結(jié)果修改為數(shù)組或者Collection
子類即可。
- 單行多列 List<String>
- 多行多列 List<Map<String, Object>>
- 多行隊列 List<Object[]>
- 多行隊列 List<UseDTO>
- 多行隊列 Object[],每一個Object元素都是一個數(shù)組
- ...
原文:https://springboot.io/t/topic/2234
到此這篇關(guān)于spring-data-jpa中jpql的投影查詢的文章就介紹到這了,更多相關(guān)spring-data-jpa jpql投影查詢內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
gateway網(wǎng)關(guān)接口請求的校驗方式
這篇文章主要介紹了gateway網(wǎng)關(guān)接口請求的校驗方式,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2021-07-07Java Comparable 和 Comparator 的詳解及區(qū)別
這篇文章主要介紹了Java Comparable 和 Comparator 的詳解及區(qū)別的相關(guān)資料,Comparable 自然排序和Comparator 定制排序的實例,需要的朋友可以參考下2016-12-12