如何理解spring-data-jpa中jpql的投影查詢(xún)

這篇文章主要講解了“如何理解spring-data-jpa中jpql的投影查詢(xún)”，文中的講解內(nèi)容簡(jiǎn)單清晰，易于學(xué)習(xí)與理解，下面請(qǐng)大家跟著小編的思路慢慢深入，一起來(lái)研究和學(xué)習(xí)“如何理解spring-data-jpa中jpql的投影查詢(xún)”吧！

投影查詢(xún)，就是僅僅檢索表的部分字段。而不是粗暴的 SELECT * FROM...檢索出所有列數(shù)據(jù)。例如檢索用戶(hù)余額信息的時(shí)候，就不需要檢索用戶(hù)的頭像，創(chuàng)建日期等字段。節(jié)省了帶寬傳輸和內(nèi)存占用，也避免了可能暴露更多數(shù)據(jù)給客戶(hù)端。

這里先啰嗦一下jpql的一些注意點(diǎn)

• 操作的是對(duì)象 @Entity, 不是表, 操作的是對(duì)象屬性, 也不是表字段

• 默認(rèn)Entity名稱(chēng)就是類(lèi)名稱(chēng)大寫(xiě), 也可以通過(guò)修改 @Entity 屬性的注解來(lái)修改

• 不支持使用 `` 符號(hào), 不支持在末尾添加分號(hào): ;

• 支持使用 AS 關(guān)鍵字起別名

準(zhǔn)備一個(gè)演示用的實(shí)體類(lèi)

import javax.persistence.*;

import java.io.Serializable;
import java.time.LocalDateTime;

/**
 * 用戶(hù)
 */
@Entity
@Table(name = "user", indexes = { 
		@Index(columnList = "account", unique = true),
})
@org.hibernate.annotations.Table(appliesTo = "user", comment = "用戶(hù)")
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;

	// 登錄賬戶(hù)
	@Column(columnDefinition = "VARCHAR(20) COMMENT '登錄賬戶(hù)'", nullable = false)
	private String account;
	
	// 昵稱(chēng)
	@Column(columnDefinition = "VARCHAR(20) COMMENT '昵稱(chēng)'")
	private String name;

	// 頭像
	@Column(columnDefinition = "VARCHAR(255) COMMENT '頭像'")
	private String avatar;

	// 創(chuàng)建時(shí)間
	@Column(name = "created_date", columnDefinition = "timestamp DEFAULT CURRENT_TIMESTAMP COMMENT '創(chuàng)建時(shí)間'", nullable = false)
	private LocalDateTime createdDate;

	// 最后修改時(shí)間
	@Column(name = "last_modified_date", columnDefinition = "timestamp NULL DEFAULT NULL COMMENT '最后一次修改時(shí)間'")
	private LocalDateTime lastModifiedDate;

	// 記錄狀態(tài)
	@Column(columnDefinition = "TINYINT(1) unsigned COMMENT '是否啟用'", nullable = false)
	private Boolean enabled;
}

檢索單行單列數(shù)據(jù)

單行單列數(shù)據(jù)，比較簡(jiǎn)單了。返回的列數(shù)據(jù)類(lèi)型是什么，Repository接口中檢索方法的返回值就定義什么即可。

根據(jù)用戶(hù)ID檢索 賬戶(hù)字段

public interface UserRepository extends JpaRepository<User, Integer>, JpaSpecificationExecutor <User> {
	
	/**
	 * 根據(jù)用戶(hù)ID，檢索賬戶(hù)信息
	 * @param id
	 * @return
	 */
	@Query("SELECT u.account FROM User AS u WHERE u.id = :id")
	String accountById(@Param("id") Integer id);
}

測(cè)試代碼

@Autowired
private UserRepository userRepository;

@Test
@Transactional(readOnly = true)
public void test () {
	String account = userRepository.accountById(1);
	LOGGER.info("account={}", account);
}

執(zhí)行日志

在日志中可以看到執(zhí)行的SQL符合要求，僅僅檢索了一個(gè)列，并且返回了正確的結(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ù)

使用自定義對(duì)象 的構(gòu)造器封裝結(jié)果集

自定義一個(gè)封裝結(jié)果集的對(duì)象

這里直接繼承了User類(lèi)，并且需要通過(guò)構(gòu)造函數(shù)來(lái)定義需要投影檢索的列

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ù)檢索出用戶(hù)的基本信息：賬戶(hù)，昵稱(chēng)，創(chuàng)建時(shí)間，封裝結(jié)果集為UserDTO對(duì)象

使用jpql中的NEW關(guān)鍵字指定自定義對(duì)象的全路徑，并且在構(gòu)造函數(shù)中指定要檢索的列，既有sql的語(yǔ)法，又有面向?qū)ο蟮乃枷搿?/p>

/**
 * 根據(jù)檢索出用戶(hù)的基本信息：賬戶(hù)，昵稱(chēng)，創(chuàng)建時(shí)間，封裝結(jié)果集為UserDTO對(duì)象
 * @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);

測(cè)試

@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ù)組集合，并不需要重新定義對(duì)象，但是缺點(diǎn)就是需要自己記住每個(gè)數(shù)組下標(biāo)下的數(shù)據(jù)代表的是什么 。

根據(jù)檢索出用戶(hù)的基本信息：賬戶(hù)，昵稱(chēng)，創(chuàng)建時(shí)間，封裝結(jié)果集為Object數(shù)組

/**
 * 根據(jù)檢索出用戶(hù)的基本信息：賬戶(hù)，昵稱(chēng)，創(chuàng)建時(shí)間，封裝結(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就會(huì)把結(jié)果集封裝為一個(gè)二維數(shù)組，適合多行多列的情況。

這里演示的是根據(jù)id檢索，只可能是單行，多列。所以定義成Object，自己強(qiáng)轉(zhuǎn)換一下就好了。

測(cè)試

@Autowired
private UserRepository userRepository;

@Test
@Transactional(readOnly = true)
public void test () {
	// 強(qiáng)制轉(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é)果集的好處就是，不需要重新定義對(duì)象。而且可以根據(jù)key找到自己要的字段。我覺(jué)得最方便的一種 方法了，借助于spring的,BeanUtils，可以把Map轉(zhuǎn)換為對(duì)象。

根據(jù)檢索出用戶(hù)的基本信息：賬戶(hù)，昵稱(chēng)，創(chuàng)建時(shí)間，封裝結(jié)果集為“Map<String, Object>”

/**
 * 根據(jù)檢索出用戶(hù)的基本信息：賬戶(hù)，昵稱(chēng)，創(chuàng)建時(shí)間，封裝結(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);

需要對(duì)檢索的列, 使用AS起別名, 作為key的名稱(chēng)，如果不使用AS別名的話(huà)，單行單列的情況下, key = null, 多行的情況下, key = 序號(hào)(從0開(kāi)始)

{
	"0":"Vin",
	"1":“KevinBlandy”
}

測(cè)試代碼

@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行

對(duì)于有多行的記錄封裝，就很簡(jiǎn)單了。在上面的基礎(chǔ)上，把返回值結(jié)果修改為數(shù)組或者Collection子類(lèi)即可。

• 單行多列 List<String>

• 多行多列 List<Map<String, Object>>

• 多行隊(duì)列 List<Object[]>

• 多行隊(duì)列 List<UseDTO>

• 多行隊(duì)列 Object[]，每一個(gè)Object元素都是一個(gè)數(shù)組

• ...

感謝各位的閱讀，以上就是“如何理解spring-data-jpa中jpql的投影查詢(xún)”的內(nèi)容了，經(jīng)過(guò)本文的學(xué)習(xí)后，相信大家對(duì)如何理解spring-data-jpa中jpql的投影查詢(xún)這一問(wèn)題有了更深刻的體會(huì)，具體使用情況還需要大家實(shí)踐驗(yàn)證。這里是億速云，小編將為大家推送更多相關(guān)知識(shí)點(diǎn)的文章，歡迎關(guān)注！