SpringData如何通過@Query註解支持JPA語句和原生SQL語句
通過@Query註解支持JPA語句和原生SQL語句
在SpringData中們可是使用繼承接口直接按照規則寫方法名即可完成查詢的方法，不需要寫具體的實現，但是這樣寫又是不能滿足我們的需求，比如子查詢，SpringData中提供瞭@Query註解可以讓我們寫JPA的語句和原生的SQL語句，那接下來看看怎麼寫JPA的查詢語句和原生的SQL語句。
package com.springdata.study.repository;
import java.util.List;
import org.springframework.data.jpa.repository.Query;
import org.springframework.data.repository.Repository;
import org.springframework.data.repository.query.Param;
import com.springdata.study.entitys.Person;
//1.實際上Repository是一個口接口，沒有提供任何方法，是一個標記接口
//2.實現瞭Repository接口就會被spring IOC容器識別為Repository Bean
// 會被納入IOC容器中
//3.Repository接口也可以同@RepositoryDefinition 註解代替，效果是一樣的
//4.接口中的泛型：第一個是那個實體類的Repository，第二個是實體類的主鍵的類型
//@RepositoryDefinition(domainClass=Person.class,idClass=Integer.class)
/**
* 在Repository接口中申明方法 1.申明方法需要符合一定的規范 2.查詢方法需要以 find | read | get開頭 3.涉及查詢條件時
* 需要用條件關鍵字連接 4.屬性首字母大寫 5.支持級聯屬性
* 6.AddressId若當前實體類中有屬性，則優先使用該屬性，若想要使用級聯屬性，需要用下劃線隔開Address_Id
*/
public interface PersonRepositoiry extends Repository<Person, Integer> {
// select p from Person where p.name = ?
Person getByName(String name);
List<Person> findByNameStartingWithAndIdLessThan(String name, Integer id);
// where name like %? and id < ?
List<Person> findByNameEndingWithAndIdLessThan(String name, Integer id);
// where email in ? age < ?
List<Person> readByEmailInOrAgeLessThan(List<String> emails, int age);
// 級聯屬性查詢
// where address.id > ?
List<Person> findByAddress_IdGreaterThan(Integer is);
// 可以使用@Query註解在其value屬性中寫JPA語句靈活查詢
@Query("SELECT p FROM Person p WHERE p.id = (SELECT max(p2.id) FROM Person p2)")
Person getMaxIdPerson();
// 在@Query註解中使用占位符
@Query(value = "SELECT p FROM Person p where p.name = ?1 and p.email = ?2")
List<Person> queryAnnotationParam1(String name, String email);
// 使用命名參數傳遞參數
@Query(value = "SELECT p FROM Person p where p.name = :name")
List<Person> queryAnnotationParam2(@Param("name") String name);
// SpringData可以在參數上添加%
@Query("SELECT p FROM Person p WHERE p.name LIKE %?1%")
List<Person> queryAnnotationLikeParam(String name);
// SpringData可以在參數上添加%
@Query("SELECT p FROM Person p WHERE p.name LIKE %:name%")
List<Person> queryAnnotationLikeParam2(@Param("name")String name);
//在@Query註解中添加nativeQuery=true屬性可以使用原生的SQL查詢
@Query(value="SELECT count(*) FROM jpa_person", nativeQuery=true)
long getTotalRow();
}
下面是這個類的測試類
package com.springdata.study.test;
import java.sql.SQLException;
import java.util.Arrays;
import java.util.List;
import javax.sql.DataSource;
import org.junit.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;
import com.springdata.study.entitys.Person;
import com.springdata.study.repository.PersonRepositoiry;
import com.springdata.study.service.PersonService;
public class DataSourceTest {
private ApplicationContext applicationContext;
private PersonService personService;
private PersonRepositoiry personRepositoiry;
{
applicationContext = new ClassPathXmlApplicationContext("applicationContext.xml");
personRepositoiry = applicationContext.getBean(PersonRepositoiry.class);
personService = applicationContext.getBean(PersonService.class);
}
@SuppressWarnings("resource")
@Test
public void testDataSource() throws SQLException {
ApplicationContext applicationContext = new ClassPathXmlApplicationContext("applicationContext.xml");
DataSource dataSource = applicationContext.getBean(DataSource.class);
System.out.println(dataSource.getConnection());
}
@Test
public void testSpringdata() {
Object person = personService.getPerson("LQF");
System.out.println(person);
}
@Test
public void testFindByNameStartingWithAndIdLessThan() {
List<Person> persons = personRepositoiry.findByNameStartingWithAndIdLessThan("g", 6);
persons = personRepositoiry.findByNameEndingWithAndIdLessThan("g", 6);
System.out.println(persons);
}
@Test
public void testReadByEmailInOrAgeLessThan() {
List<Person> persons = personRepositoiry.readByEmailInOrAgeLessThan(Arrays.asList("[email protected]"), 25);
System.out.println(persons);
}
@Test
public void testFindByAddressIdGreaterThan() {
personRepositoiry.findByAddress_IdGreaterThan(1);
}
@Test
public void testGetMaxIdPerson() {
Person person = personRepositoiry.getMaxIdPerson();
System.out.println(person);
}
@Test
public void testQueryAnnotationParam() {
List<Person> persons = personRepositoiry.queryAnnotationParam1("liqingfeng", "[email protected]");
System.out.println(persons);
}
@Test
public void testQueryAnnotationParam2() {
List<Person> persons = personRepositoiry.queryAnnotationParam2("lqf");
System.out.println(persons);
}
@Test
public void testQueryAnnotationLikeParam() {
List<Person> persons = personRepositoiry.queryAnnotationLikeParam2("li");
System.out.println(persons);
}
@Test
public void testGetTotalRow() {
long count = personRepositoiry.getTotalRow();
System.out.println(count);
}
}
@Query註解的用法(Spring Data JPA)
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);
補充說明：
有同學提出來瞭，例子5中用’#{#entityName}’為啥取不到值啊？
先來說一說’#{#entityName}’到底是個啥。從字面來看，’#{#entityName}’不就是實體類的名稱麼，對，他就是。
實體類Book,使用@Entity註解後，spring會將實體類Book納入管理。默認’#{#entityName}’的值就是’Book’。
但是如果使用瞭@Entity(name = “book”)來註解實體類Book,此時’#{#entityName}’的值就變成瞭’book’。
到此，事情就明瞭瞭，隻需要在用@Entity來註解實體類時指定name為此實體類對應的表名。在原生sql語句中，就可以把’#{#entityName}’來作為數據表名使用。
以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。
推薦閱讀：
- spring data jpa @Query註解中delete語句報錯的解決
- 基於JPA的Repository使用詳解
- JPA中JpaRepository接口的使用方式
- 使用JPA自定義SQL查詢結果
- Springboot JPA如何使用distinct返回對象