Spring data jpa中Query和@Query分別返回map結果集

引用：

http://blog.csdn.net/yingxiake/article/details/51016234

http://blog.csdn.net/yingxiake/article/details/51016234

http://www.cnblogs.com/zj0208/p/6008627.html

 

Query的使用：

在JPA 2.0 中我們可以使用entityManager.createNativeQuery()來執行原生的SQL語句。 但當我們查詢結果沒有對應實體類時，query.getResultList()返回的是一個List<Object[]>。也就是說每行的數據被作為一個對象數組返回。

常見的用法是這樣的：

public void testNativeQuery(){ Query query = entityManager.createNativeQuery("select id, name, age from t_user"); List rows = query.getResultList(); for (Object row : rows) { Object[] cells = (Object[]) row; System.out.println("id = " + cells[0]); System.out.println("name = " + cells[1]); System.out.println("age = " + cells[2]); } } 

這樣用會使代碼非常不容易讓人理解， 究竟下標為0的元素到底是什么， 不去數查詢語句是不知道的，而且一旦查詢語句被調整，Java代碼也要一起調整。這時候我們想如果返回的是Map的話，用起來會清晰的多。

可惜的是JPA的API中並沒有提供這樣的設置。其實很多JPA的底層實現都是支持返回Map對象的。例如：
EclipseLink的query.setHint(QueryHints.RESULT_TYPE, ResultType.Map); 
Hibernate的.setResultTransformer(Transformers.ALIAS_TO_ENTITY_MAP);

所以，如果我們想要返回Map並且確定底層用的是某一種JPA的實現時我們可以退而求其次， 犧牲跨實現的特性來滿足我們的需求：

 

    public void testNativeQuery(){ Query query = entityManager.createNativeQuery("select id, name, age from t_user"); query.unwrap(SQLQuery.class).setResultTransformer(Transformers.ALIAS_TO_ENTITY_MAP); List rows = query.getResultList(); for (Object obj : rows) { Map row = (Map) obj; System.out.println("id = " + row.get("ID")); System.out.println("name = " + row.get("NAME")); System.out.println("age = " + row.get("AGE")); } } 
 或者
 public List<Map> findMapBySql(String sqlStr) {
        Session session = getEntityManager().unwrap(Session.class);
        return session.createSQLQuery(sqlStr).setResultTransformer(Transformers.ALIAS_TO_ENTITY_MAP).list();
    }

 

這里需要注意的是， 用Map肯定要比用Object數組來的效率低。所以你要看性能下降是否在可接受范圍內。再就是在我的Hibernate 4.2.x的環境下，無論你原生SQL中寫的是大寫字母還是小寫字母，返回的字段名都是大寫的。當然你可以通過自定義ResultTransformer的形式對字段名進行一定的處理， 甚至是返回自己需要的POJO。

 

還有一種更簡單的辦法：

 

Query query = em.createNativeQuery(sql,java.util.Map.class); 

 

這樣就可以直接返回Map格式的結果集了。

 

@Query的使用

1. 一個使用@Query注解的簡單例子

@Query(value = "select name,author,price from Book b where b.price>?1 and b.price<?2")
List<Book> findByPriceRange(long price1, long price2);

 

2.  Like表達式

@Query(value = "select name,author,price from Book b where b.name like %:name%")
List<Book> findByNameMatch(@Param("name") String name);

 

3. 使用Native SQL Query

所謂本地查詢，就是使用原生的sql語句（根據數據庫的不同，在sql的語法或結構方面可能有所區別）進行查詢數據庫的操作。

@Query(value = "select * from book b where b.name=?1", nativeQuery = true) List<Book> findByName(String name);

 

4. 使用@Param注解注入參數

@Query(value = "select name,author,price from Book b where b.name = :name AND b.author=:author AND b.price=:price")
List<Book> findByNamedParam(@Param("name") String name, @Param("author") String author, @Param("price") long price);

 

5. SPEL表達式(使用時請參考最后的補充說明)

   '#{#entityName}'值為'Book'對象對應的數據表名稱(book)。

public interface BookQueryRepositoryExample extends Repository<Book, Long>{

       @Query(value = "select * from #{#entityName} b where b.name=?1", nativeQuery = true)
       List<Book> findByName(String name);

}

 

6. 一個較完整的例子

public interface BookQueryRepositoryExample extends Repository<Book, Long> { @Query(value = "select * from Book b where b.name=?1", nativeQuery = true) List<Book> findByName(String name);// 此方法sql將會報錯(java.lang.IllegalArgumentException)，看出原因了嗎,若沒看出來，請看下一個例子 @Query(value = "select name,author,price from Book b where b.price>?1 and b.price<?2") List<Book> findByPriceRange(long price1, long price2); @Query(value = "select name,author,price from Book b where b.name like %:name%") List<Book> findByNameMatch(@Param("name") String name); @Query(value = "select name,author,price from Book b where b.name = :name AND b.author=:author AND b.price=:price") List<Book> findByNamedParam(@Param("name") String name, @Param("author") String author, @Param("price") long price); }

 

7.  解釋例6中錯誤的原因：

     因為指定了nativeQuery = true，即使用原生的sql語句查詢。使用java對象'Book'作為表名來查自然是不對的。只需將Book替換為表名book。

@Query(value = "select * from book b where b.name=?1", nativeQuery = true) List<Book> findByName(String name);

 

8. 在這里我們說下，spring data jpa的查詢策略，spring data jpa可以利用創建方法進行查詢，也可以利用@Query注釋進行查詢，那么如果在命名規范的方法上使用了@Query，那spring data jpa是執行我們定義的語句進行查詢，還是按照規范的方法進行查詢呢？看下查詢策略

查詢策略的配置可以在配置query-lookup-strategy，例如這樣

    <jpa:repositories base-package="com.liuxg.**.dao" repository-impl-postfix="Impl" query-lookup-strategy = "create-if-not-found" entity-manager-factory-ref="entityManagerFactory" transaction-manager-ref="transactionManager" > </jpa:repositories>

它有三種值可以配置

1. create-if-not-found(默認)：如果通過 @Query指定查詢語句，則執行該語句，如果沒有，則看看有沒有@NameQuery指定的查詢語句，如果還沒有，則通過解析方法名進行查詢

2. create：通過解析方法名字來創建查詢。即使有 @Query，@NameQuery都會忽略

3. use-declared-query：通過執行@Query定義的語句來執行查詢，如果沒有，則看看有沒有通過執行@NameQuery來執行查詢，還沒有則拋出異常

@Query就先看到這里，下次再了解下怎么拓展spring data jpa 接口，例如我既想用sping data jpa的接口，可是我又想自己定義一些接口，我們把他們合二為一呢？？

 

補充說明(2017-01-12)：

　　有同學提出來了，例子5中用'#{#entityName}'為啥取不到值啊？

　　先來說一說'#{#entityName}'到底是個啥。從字面來看，'#{#entityName}'不就是實體類的名稱么，對，他就是。

　　實體類Book,使用@Entity注解后，spring會將實體類Book納入管理。默認'#{#entityName}'的值就是'Book'。

　　但是如果使用了@Entity(name = "book")來注解實體類Book,此時'#{#entityName}'的值就變成了'book'。

　　到此，事情就明了了，只需要在用@Entity來注解實體類時指定name為此實體類對應的表名。在原生sql語句中，就可以把'#{#entityName}'來作為數據表名使用。