七、springboot整合Spring-data-jpa
1.Spring Data JPA是什麽
由Spring提供的一個用於簡化JPA開發的框架。可以在幾乎不用寫實現的情況下，實現對數據的訪問和操作。除了CRUD外，還包括如分頁、排序等一些常用的功能
1.Spring Data JPA的核心概念：
1：Repository：最頂層的接口，是一個空的接口，目的是為了統一所有Repository的類型，且能讓組件掃描的時候自動識別。
2：CrudRepository ：是Repository的子接口，提供CRUD的功能
3：PagingAndSortingRepository：是CrudRepository的子接口，添加分頁和排序的功能
4：JpaRepository：是PagingAndSortingRepository的子接口，增加了一些實用的功能，比如：批量操作等。
5：JpaSpecificationExecutor：用來做負責查詢的接口
6：Specification：是Spring Data JPA提供的一個查詢規範，要做復雜的查詢，只需圍繞這個規範來設置查詢條件即可
2.JpaRepository的查詢
具體的關鍵字，使用方法和生產成SQL如下表所示
| Keyword | Sample | JPQL snippet |
|---|---|---|
| And | findByLastnameAndFirstname | … where x.lastname = ?1 and x.firstname = ?2 |
| Or | findByLastnameOrFirstname | … where x.lastname = ?1 or x.firstname = ?2 |
| Is,Equals | findByFirstnameIs,findByFirstnameEquals | … where x.firstname = ?1 |
| Between | findByStartDateBetween | … where x.startDate between ?1 and ?2 |
| LessThan | findByAgeLessThan | … where x.age < ?1 |
| LessThanEqual | findByAgeLessThanEqual | … where x.age ? ?1 |
| GreaterThan | findByAgeGreaterThan | … where x.age > ?1 |
| GreaterThanEqual | findByAgeGreaterThanEqual | … where x.age >= ?1 |
| After | findByStartDateAfter | … where x.startDate > ?1 |
| Before | findByStartDateBefore | … where x.startDate < ?1 |
| IsNull | findByAgeIsNull | … where x.age is null |
| IsNotNull,NotNull | findByAge(Is)NotNull | … where x.age not null |
| Like | findByFirstnameLike | … where x.firstname like ?1 |
| NotLike | findByFirstnameNotLike | … where x.firstname not like ?1 |
| StartingWith | findByFirstnameStartingWith | … where x.firstname like ?1 (parameter bound with appended %) |
| EndingWith | findByFirstnameEndingWith | … where x.firstname like ?1 (parameter bound with prepended %) |
| Containing | findByFirstnameContaining | … where x.firstname like ?1 (parameter bound wrapped in %) |
| OrderBy | findByAgeOrderByLastnameDesc | … where x.age = ?1 order by x.lastname desc |
| Not | findByLastnameNot | … where x.lastname <> ?1 |
| In | findByAgeIn(Collection ages) | … where x.age in ?1 |
| NotIn | findByAgeNotIn(Collection age) | … where x.age not in ?1 |
| TRUE | findByActiveTrue() | … where x.active = true |
| FALSE | findByActiveFalse() | … where x.active = false |
| IgnoreCase | findByFirstnameIgnoreCase | … where UPPER(x.firstame) = UPPER(?1) |
Spring Data JPA框架在進行方法名解析時，會先把方法名多余的前綴截取掉，比如 find、findBy、read、readBy、get、getBy，然後對剩下部分進行解析。
假如創建如下的查詢：findByUserDepUuid()，框架在解析該方法時，首先剔除 findBy，然後對剩下的屬性進行解析，假設查詢實體為Doc
1：先判斷 userDepUuid （根據 POJO 規範，首字母變為小寫）是否為查詢實體的一個屬性，如果是，則表示根據該屬性進行查詢；如果沒有該屬性，繼續第二步；
2：從右往左截取第一個大寫字母開頭的字符串此處為Uuid），然後檢查剩下的字符串是否為查詢實體的一個屬性，如果是，則表示根據該屬性進行查詢；如果沒有該屬性，則重復第二步，繼續從右往左截取；最後假設user為查詢實體的一個屬性；
3：接著處理剩下部分（DepUuid），先判斷 user 所對應的類型是否有depUuid屬性，如果有，則表示該方法最終是根據 “ Doc.user.depUuid” 的取值進行查詢；否則繼續按照步驟 2 的規則從右往左截取，最終表示根據 “Doc.user.dep.uuid” 的值進行查詢。
4:可能會存在一種特殊情況，比如 Doc包含一個 user 的屬性，也有一個 userDep 屬性，此時會存在混淆。可以明確在屬性之間加上 "_" 以顯式表達意圖，比如 "findByUser_DepUuid()" 或者 "findByUserDep_uuid()"
特殊的參數： 還可以直接在方法的參數上加入分頁或排序的參數，比如：
Page<UserModel> findByName(String name, Pageable pageable);
List<UserModel> findByName(String name, Sort sort);
也可以使用JPA的NamedQueries，方法如下：
1：在實體類上使用@NamedQuery，示例如下：
@NamedQuery(name = "UserModel.findByAge",query = "select o from UserModel o where o.age >= ?1")
2：在自己實現的DAO的Repository接口裏面定義一個同名的方法，示例如下：
public List<UserModel> findByAge(int age);
3：然後就可以使用了，Spring會先找是否有同名的NamedQuery，如果有，那麽就不會按照接口定義的方法來解析。
使用@Query
可以在自定義的查詢方法上使用@Query來指定該方法要執行的查詢語句，比如：
@Query("select o from UserModel o where o.uuid=?1")
public List<UserModel> findByUuidOrAge(int uuid);
註意：
1：方法的參數個數必須和@Query裏面需要的參數個數一致
2：如果是like，後面的參數需要前面或者後面加“%”，比如下面都對：
@Query("select o from UserModel o where o.name like ?1%")
public List<UserModel> findByUuidOrAge(String name);
@Query("select o from UserModel o where o.name like %?1")
public List<UserModel> findByUuidOrAge(String name);
@Query("select o from UserModel o where o.name like %?1%")
public List<UserModel> findByUuidOrAge(String name);
當然，這樣在傳遞參數值的時候就可以不加‘%’了，當然加了也不會錯
n還可以使用@Query來指定本地查詢，只要設置nativeQuery為true，比如：
@Query(value="select * from tbl_user where name like %?1" ,nativeQuery=true)
public List<UserModel> findByUuidOrAge(String name);
註意：當前版本的本地查詢不支持翻頁和動態的排序
使用命名化參數，使用@Param即可，比如：
@Query(value="select o from UserModel o where o.name like %:nn")
public List<UserModel> findByUuidOrAge(@Param("nn") String name);
同樣支持更新類的Query語句，添加@Modifying即可，比如：
@Modifying
@Query(value="update UserModel o set o.name=:newName where o.name like %:nn")
public int findByUuidOrAge(@Param("nn") String name,@Param("newName") String newName);
註意：
1：方法的返回值應該是int，表示更新語句所影響的行數
2：在調用的地方必須加事務，沒有事務不能正常執行
JpaRepository的查詢功能
創建查詢的順序
Spring Data JPA 在為接口創建代理對象時，如果發現同時存在多種上述情況可用，它該優先采用哪種策略呢？
<jpa:repositories> 提供了 query-lookup-strategy 屬性，用以指定查找的順序。它有如下三個取值：
1：create-if-not-found：如果方法通過@Query指定了查詢語句，則使用該語句實現查詢；如果沒有，則查找是否定義了符合條件的命名查詢，如果找到，則使用該命名查詢；如果兩者都沒有找到，則通過解析方法名字來創建查詢。這是 query-lookup-strategy 屬性的默認值
2：create：通過解析方法名字來創建查詢。即使有符合的命名查詢，或者方法通過 @Query指定的查詢語句，都將會被忽略
3：use-declared-query：如果方法通過@Query指定了查詢語句，則使用該語句實現查詢；如果沒有，則查找是否定義了符合條件的命名查詢，如果找到，則使用該命名查詢；如果兩者都沒有找到，則拋出異常
3.Specifications查詢
Spring Data JPA支持JPA2.0的Criteria查詢，相應的接口是JpaSpecificationExecutor。 Criteria 查詢：是一種類型安全和更面向對象的查詢 這個接口基本是圍繞著Specification接口來定義的， Specification接口中只定義了如下一個方法： Predicate toPredicate(Root<T> root, CriteriaQuery<?> query, CriteriaBuilder cb); 要理解這個方法，以及正確的使用它，就需要對JPA2.0的Criteria查詢有一個足夠的熟悉和理解，因為這個方法的參數和返回值都是JPA標準裏面定義的對象。 Criteria查詢基本概念 Criteria 查詢是以元模型的概念為基礎的，元模型是為具體持久化單元的受管實體定義的，這些實體可以是實體類，嵌入類或者映射的父類。 CriteriaQuery接口：代表一個specific的頂層查詢對象，它包含著查詢的各個部分，比如：select 、from、where、group by、order by等 註意：CriteriaQuery對象只對實體類型或嵌入式類型的Criteria查詢起作用 Root接口：代表Criteria查詢的根對象，Criteria查詢的查詢根定義了實體類型，能為將來導航獲得想要的結果，它與SQL查詢中的FROM子句類似 1：Root實例是類型化的，且定義了查詢的FROM子句中能夠出現的類型。 2：查詢根實例能通過傳入一個實體類型給 AbstractQuery.from方法獲得。 3：Criteria查詢，可以有多個查詢根。 4：AbstractQuery是CriteriaQuery 接口的父類，它提供得到查詢根的方法。 CriteriaBuilder接口：用來構建CritiaQuery的構建器對象 Predicate：一個簡單或復雜的謂詞類型，其實就相當於條件或者是條件組合。 Criteria查詢 基本對象的構建 1：通過EntityManager的getCriteriaBuilder或EntityManagerFactory的getCriteriaBuilder方法可以得到CriteriaBuilder對象 2：通過調用CriteriaBuilder的createQuery或createTupleQuery方法可以獲得CriteriaQuery的實例 3：通過調用CriteriaQuery的from方法可以獲得Root實例 過濾條件 1：過濾條件會被應用到SQL語句的FROM子句中。在criteria 查詢中，查詢條件通過Predicate或Expression實例應用到CriteriaQuery對象上。 2：這些條件使用 CriteriaQuery .where 方法應用到CriteriaQuery 對象上 3：CriteriaBuilder也作為Predicate實例的工廠，通過調用CriteriaBuilder 的條件方法（ equal，notEqual， gt， ge，lt， le，between，like等）創建Predicate對象。 4：復合的Predicate 語句可以使用CriteriaBuilder的and, or andnot 方法構建。 構建簡單的Predicate示例： Predicate p1=cb.like(root.get(“name”).as(String.class), “%”+uqm.getName()+“%”); Predicate p2=cb.equal(root.get("uuid").as(Integer.class), uqm.getUuid()); Predicate p3=cb.gt(root.get("age").as(Integer.class), uqm.getAge()); 構建組合的Predicate示例： Predicate p = cb.and(p3,cb.or(p1,p2));2.與springboot整合
maven：
<dependency <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-data-jpa</artifactId> </dependency>
gradle：
dependencies {
compile(‘org.springframework.boot:spring-boot-starter-data-jpa‘)
}
註：需要配置數據源
jpa可選配置
spring.jpa.database=
spring.jpa.show-sql=
spring.jpa.properties=
spring.jpa.generate-ddl=
spring.jpa.open-in-view=
spring.jpa.database-platform=
spring.jpa.hibernate.ddl-auto=
spring.data.jpa.repositories.enabled=
spring.jpa.hibernate.naming-strategy=
3.項目中部分java代碼
@NoRepositoryBean public interface DAOInterface<T> extends JpaRepository<T, String>, JpaSpecificationExecutor<T> { }
public interface JDCommodityRepository extends DAOInterface<JDCommodityBean> { /** * 分頁查詢商品 */ Page<JDCommodityBean> findAll(Specification<JDCommodityBean> spec, Pageable pageable); }
@Transactional(rollbackFor = Exception.class) @Service public class JDCommodityServiceImpl extends BaseService<JDCommodityBean> implements JDCommodityService { @PersistenceContext private EntityManager entityManager; @Autowired private JDCommodityRepository jdCommodityRepository; @Override public Page<JDCommodityBean> getJDCommodityListByPage(Integer pageNum, String name, String goodsCategory) { Specification<JDCommodityBean> spec = new Specification<JDCommodityBean>() { /** * 構造斷言 * * @param root * 實體對象引用 * @param query * 規則查詢對象 * @param cb * 規則構建對象 * @return 斷言 */ @Override public Predicate toPredicate(Root<JDCommodityBean> root, CriteriaQuery<?> query, CriteriaBuilder cb) { List<Predicate> predicates = new ArrayList<>(); // 所有的斷言集合 //默認 predicates.add(cb.equal(root.get("state").as(Integer.class), 1));// 上下架狀態 1為上架，0為下架 predicates.add(cb.equal(root.get("saleState").as(Integer.class), 1));// 是否可售，1：是，0：否 predicates.add(cb.equal(root.get("isCanVAT").as(Integer.class), 1));// 是否可開增票，1：支持，0：不支持 predicates.add(cb.le(root.get("price").as(BigDecimal.class), 500));// 價格小於等於500 //自定義 // 商品名稱 if(null != name && !"".equals(name) && !"‘‘".equals(name) && name != "") { predicates.add(cb.like(root.get("name").as(String.class), "%" + name + "%")); } // 商品分類 if(goodsCategory != null && !"".equals(goodsCategory) && !"‘‘".equals(goodsCategory)) { predicates.add(cb.equal(root.get("goodsCategory").as(String.class), goodsCategory)); } return cb.and(predicates.toArray(new Predicate[predicates.size()])); } }; Pageable pageable = new PageRequest(pageNum - 1, JDCommonConstant.COMMODITY_PAGE_SIZE);// 頁碼：前端從1開始，jpa從0開始 Page<JDCommodityBean> page = jdCommodityRepository.findAll(spec, pageable); return page; } @Override protected EntityManager getEntityManager() { return entityManager; } @Override protected DAOInterface<JDCommodityBean> getDAOInterface() { return jdCommodityRepository; } }
參考：
https://legacy.gitbook.com/book/ityouknow/spring-data-jpa-reference-documentation/details
http://www.ityouknow.com/springboot/2016/08/20/springboot(%E4%BA%94)-spring-data-jpa%E7%9A%84%E4%BD%BF%E7%94%A8.html
七、springboot整合Spring-data-jpa