轉(zhuǎn)自：https://www.cnblogs.com/rulian/p/6533109.html

一、相關(guān)接口方法

在繼承JpaRepository接口后，自動擁有了按“實(shí)例”進(jìn)行查詢的諸多方法。這些方法主要在兩個(gè)接口中定義，一是QueryByExampleExecutor，一個(gè)是JpaRepository，如下所示： public interface QueryByExampleExecutor<T> { <S extends T> S findOne(Example<S> example); //根據(jù)“實(shí)例”查找一個(gè)對象。 <S extends T> Iterable<S> findAll(Example<S> example); //根據(jù)“實(shí)例”查找一批對象 <S extends T> Iterable<S> findAll(Example<S> example, Sort sort); //根據(jù)“實(shí)例”查找一批對象，且排序 <S extends T> Page<S> findAll(Example<S> example, Pageable pageable); //根據(jù)“實(shí)例”查找一批對象，且排序和分頁 <S extends T> long count(Example<S> example); //根據(jù)“實(shí)例”查找，返回符合條件的對象個(gè)數(shù) <S extends T> boolean exists(Example<S> example); //根據(jù)“實(shí)例”判斷是否有符合條件的對象 }

?

@NoRepositoryBean public interface JpaRepository<T, ID extends Serializable> extends PagingAndSortingRepository<T, ID>, QueryByExampleExecutor<T> {...... @Override <S extends T> List<S> findAll(Example<S> example); //根據(jù)實(shí)例查詢 @Override <S extends T> List<S> findAll(Example<S> example, Sort sort);//根據(jù)實(shí)例查詢，并排序。 }

?

二、快速入門

觀察上面的方法，其參數(shù)都有一個(gè) Example 類對象，這就一個(gè)“實(shí)例”（個(gè)人翻譯的叫法，未必準(zhǔn)確），它代表的是查詢條件，它是通過包裝要查詢的實(shí)體對象而生成的。下面通過一個(gè)例子，來快速了解一下其用法。 1、定義實(shí)體類 如有 客戶信息、客戶類型 兩個(gè)實(shí)體類定義如下： /** * 客戶 */ @Entity @Table(name = "demo_lx_Customer") public class Customer extends BaseBo {private String name; //姓名private String sex; //性別private int age; //年齡private String address; //地址private boolean focus ; //是否重點(diǎn)關(guān)注private Date addTime; //創(chuàng)建時(shí)間private String remark; //備注@ManyToOneprivate CustomerType customerType; //客戶類型...... }

?

/** * 客戶類型 */ @Entity @Table(name = "demo_lx_CustomerType") public class CustomerType extends BaseBo { private String code; //編號private String name; //名稱private String remark; //備注...... }

?

2、模擬數(shù)據(jù)

加入一些模擬數(shù)據(jù)：

?

3、查詢

現(xiàn)在要查詢：地址是“鄭州市”，姓“劉”的客戶，可以這樣來寫：

　　　　　//創(chuàng)建查詢條件數(shù)據(jù)對象Customer customer = new Customer();customer.setName("劉");customer.setAddress("河南省鄭州市");//創(chuàng)建匹配器，即如何使用查詢條件ExampleMatcher matcher = ExampleMatcher.matching() //構(gòu)建對象.withMatcher("name", GenericPropertyMatchers.startsWith()) //姓名采用“開始匹配”的方式查詢.withIgnorePaths("focus"); //忽略屬性：是否關(guān)注。因?yàn)槭腔绢愋?#xff0c;需要忽略掉//創(chuàng)建實(shí)例Example<Customer> ex = Example.of(customer, matcher); //查詢List<Customer> ls = dao.findAll(ex);//輸出結(jié)果System.out.println("數(shù)量："+ls.size());for (Customer bo:ls){System.out.println(bo.getName());}

?

輸出結(jié)果： 數(shù)量：1 劉芳

?

三、認(rèn)識“實(shí)例查詢”

?

1、概念定義:

? ? 上面例子中，是這樣創(chuàng)建“實(shí)例”的：Example<Customer> ex = Example.of(customer, matcher);我們看到，Example對象，由customer和matcher共同創(chuàng)建，為講解方便，我們先來明確一些定義。

? ??A、實(shí)體對象：在持久化框架中與Table對應(yīng)的域?qū)ο?#xff0c;一個(gè)對象代表數(shù)據(jù)庫表中的一條記錄，如上例中Customer對象。在構(gòu)建查詢條件時(shí)，一個(gè)實(shí)體對象代表的是查詢條件中的“數(shù)值”部分。如：要查詢姓“劉”的客戶，實(shí)體對象只能存儲條件值“劉”。

? ??B、匹配器：ExampleMatcher對象，它是匹配“實(shí)體對象”的，表示了如何使用“實(shí)體對象”中的“值”進(jìn)行查詢，它代表的是“查詢方式”，解釋了如何去查的問題。如：要查詢姓“劉”的客戶，即姓名以“劉”開頭的客戶，該對象就表示了“以某某開頭的”這個(gè)查詢方式，如上例中:withMatcher("name", GenericPropertyMatchers.startsWith())

? ??C、實(shí)例：即Example對象，代表的是完整的查詢條件。由實(shí)體對象（查詢條件值）和匹配器（查詢方式）共同創(chuàng)建。

? ??再來理解“實(shí)例查詢”，顧名思義，就是通過一個(gè)例子來查詢。要查詢的是Customer對象，查詢條件也是一個(gè)Customer對象，通過一個(gè)現(xiàn)有的客戶對象作為例子，查詢和這個(gè)例子相匹配的對象。

?

2、特點(diǎn)及約束（局限性）:

? ??1、支持動態(tài)查詢。即支持查詢條件個(gè)數(shù)不固定的情況，如：客戶列表中有多個(gè)過濾條件，用戶使用時(shí)在“地址”查詢框中輸入了值，就需要按地址進(jìn)行過濾，如果沒有輸入值，就忽略這個(gè)過濾條件。對應(yīng)的實(shí)現(xiàn)是，在構(gòu)建查詢條件Customer對象時(shí)，將address屬性值置具體的條件值或置為null。

? ??2、不支持過濾條件分組。即不支持過濾條件用 or(或) 來連接，所有的過濾查件，都是簡單一層的用 and(并且) 連接。

? ??3、僅支持字符串的開始/包含/結(jié)束/正則表達(dá)式匹配 和?其他屬性類型的精確匹配。查詢時(shí)，對一個(gè)要進(jìn)行匹配的屬性（如：姓名 name），只能傳入一個(gè)過濾條件值，如以Customer為例，要查詢姓“劉”的客戶，“劉”這個(gè)條件值就存儲在表示條件對象的Customer對象的name屬性中，針對于“姓名”的過濾也只有這么一個(gè)存儲過濾值的位置，沒辦法同時(shí)傳入兩個(gè)過濾值。正是由于這個(gè)限制，有些查詢是沒辦法支持的，例如要查詢某個(gè)時(shí)間段內(nèi)添加的客戶，對應(yīng)的屬性是 addTime，需要傳入“開始時(shí)間”和“結(jié)束時(shí)間”兩個(gè)條件值，而這種查詢方式?jīng)]有存兩個(gè)值的位置，所以就沒辦法完成這樣的查詢。

?

四、重點(diǎn)理解ExampleMatcher

?

1、需要考慮的因素

查詢條件的表示，有兩部分，一是條件值，二是查詢方式。條件值用實(shí)體對象（如Customer對象）來存儲，相對簡單，當(dāng)頁面?zhèn)魅脒^濾條件值時(shí)，存入相對應(yīng)的屬性中，沒入傳入時(shí)，屬性保持默認(rèn)值。查詢方式是用匹配器ExampleMatcher來表示，情況相對復(fù)雜些，需要考慮的因素有： （1）Null值的處理。當(dāng)某個(gè)條件值為Null,是應(yīng)當(dāng)忽略這個(gè)過濾條件呢，還是應(yīng)當(dāng)去匹配數(shù)據(jù)庫表中該字段值是Null的記錄？ （2）基本類型的處理。如客戶Customer對象中的年齡age是int型的，當(dāng)頁面不傳入條件值時(shí)，它默認(rèn)是0，是有值的，那是否參與查詢呢？ （3）忽略某些屬性值。一個(gè)實(shí)體對象，有許多個(gè)屬性，是否每個(gè)屬性都參與過濾？是否可以忽略某些屬性？ （4）不同的過濾方式。同樣是作為String值，可能“姓名”希望精確匹配，“地址”希望模糊匹配，如何做到？ （5）大小寫匹配。字符串匹配時(shí)，有時(shí)可能希望忽略大小寫，有時(shí)則不忽略，如何做到？ 2、五個(gè)配置項(xiàng) 圍繞上面一系列情況，ExampleMatcher中定義了5項(xiàng)配置來解決這些問題。? public class ExampleMatcher { NullHandler nullHandler; //Null值處理方式 StringMatcher defaultStringMatcher; //默認(rèn)字符串匹配方式 boolean defaultIgnoreCase; //默認(rèn)大小寫忽略方式 PropertySpecifiers propertySpecifiers; //各屬性特定查詢方式 Set<String> ignoredPaths; //忽略屬性列表 ...... }

?? ?（1）nullHandler：Null值處理方式，枚舉類型，有2個(gè)可選值，INCLUDE（包括）,IGNORE（忽略）。標(biāo)識作為條件的實(shí)體對象中，一個(gè)屬性值（條件值）為Null是，是否參與過濾。當(dāng)該選項(xiàng)值是INCLUDE時(shí)，表示仍參與過濾，會匹配數(shù)據(jù)庫表中該字段值是Null的記錄；若為IGNORE值，表示不參與過濾。

（2）defaultStringMatcher：默認(rèn)字符串匹配方式，枚舉類型，有6個(gè)可選值，DEFAULT（默認(rèn)，效果同EXACT）,EXACT（相等）,STARTING（開始匹配）,ENDING（結(jié)束匹配）,CONTAINING（包含，模糊匹配）,REGEX（正則表達(dá)式）。該配置對所有字符串屬性過濾有效，除非該屬性在?propertySpecifiers?中單獨(dú)定義自己的匹配方式。 （3）defaultIgnoreCase：默認(rèn)大小寫忽略方式，布爾型，當(dāng)值為false時(shí)，即不忽略，大小不相等。該配置對所有字符串屬性過濾有效，除非該屬性在propertySpecifiers?中單獨(dú)定義自己的忽略大小寫方式。 （4）propertySpecifiers：各屬性特定查詢方式，描述了各個(gè)屬性單獨(dú)定義的查詢方式，每個(gè)查詢方式中包含4個(gè)元素：屬性名、字符串匹配方式、大小寫忽略方式、屬性轉(zhuǎn)換器。如果屬性未單獨(dú)定義查詢方式，或單獨(dú)查詢方式中，某個(gè)元素未定義（如：字符串匹配方式），則采用 ExampleMatcher 中定義的默認(rèn)值，即上面介紹的defaultStringMatcher?和?defaultIgnoreCase?的值。 （5）ignoredPaths：忽略屬性列表，忽略的屬性不參與查詢過濾。 3、操作方法

在ExampleMatcher中定義了一系列方式，用于設(shè)置這5項(xiàng)設(shè)置值，所有的設(shè)置方法均返回 ExampleMatcher 對象，所以支持鏈?zhǔn)骄幊膛渲谩?/p>

（1）創(chuàng)建一個(gè)默認(rèn)的 ExampleMatcher 對象。

定義：

public static ExampleMatcher?matching()

默認(rèn)配置如下：
A、nullHandler：IGNORE。Null值處理方式：忽略
B、defaultStringMatcher：DEFAULT。默認(rèn)字符串匹配方式：默認(rèn)（相等）
C、defaultIgnoreCase：false。默認(rèn)大小寫忽略方式：不忽略
D、propertySpecifiers：空。各屬性特定查詢方式，空。
E、ignoredPaths：空列表。忽略屬性列表，空列表。

?

（2）改變Null值處理方式。

定義：
public ExampleMatcher?withNullHandler(NullHandler nullHandler)
public ExampleMatcher?withIncludeNullValues()
public ExampleMatcher?withIgnoreNullValues()

產(chǎn)生效果：
改變配置項(xiàng)nullHandler，分別設(shè)為：指定值、INCLUDE（包括）、IGNORE（忽略）。

?

（3）改變默認(rèn)字符串匹配方式。
定義：
public ExampleMatcher?withStringMatcher(StringMatcher defaultStringMatcher)

產(chǎn)生效果：
改變配置項(xiàng)defaultStringMatcher，設(shè)為指定值。

?

（4）改變默認(rèn)大小寫忽略方式。
定義：
public ExampleMatcher?withIgnoreCase()
public ExampleMatcher?withIgnoreCase(boolean defaultIgnoreCase)

產(chǎn)生效果：
改變配置項(xiàng)defaultIgnoreCase，分別設(shè)為：true，指定值。

?

（5）向“忽略屬性列表”中添加屬性。
定義：
public ExampleMatcher?withIgnorePaths(String... ignoredPaths)

產(chǎn)生效果：
改變配置項(xiàng)ignoredPaths，向列表中添加一個(gè)或多個(gè)屬性。

?

（6）配置屬性特定查詢方式

? ? 一個(gè)屬性的特定查詢方式，包含了3個(gè)信息：字符串匹配方式、大小寫忽略方式、屬性轉(zhuǎn)換器，存儲在?propertySpecifiers?中，操作時(shí)用?GenericPropertyMatcher?類來傳遞配置信息。有4個(gè)方法來改變配置，這4個(gè)方法操作時(shí)，內(nèi)部均采用增量改變的方式，即如果沒有為屬性定義“特定查詢方式”，則會定義一個(gè)，并根據(jù)傳進(jìn)來的“非空信息”進(jìn)行配置，如果已經(jīng)定義有，則會根據(jù)傳進(jìn)來的“非空信息”進(jìn)行更新。如果一個(gè)“特定查詢方式”中的“字符串匹配方式、大小寫忽略方式”沒有設(shè)置值，查詢時(shí)則采用ExampleMatcher中的默認(rèn)配置。

?

A、自定義類的方式。

定義：
public ExampleMatcher?withMatcher(String propertyPath, MatcherConfigurer<GenericPropertyMatcher> matcherConfigurer)

產(chǎn)生效果：

向?propertySpecifiers?中增加或更新屬性“特定查詢方式”的配置。

參數(shù)說明：
propertyPath：要配置特定查詢的屬性名。
matcherConfigurer：自定義類對象。自定義類需要實(shí)現(xiàn)MatcherConfigurer接口，在接口的 configureMatcher() 實(shí)現(xiàn)方法中指定相關(guān)配置。

?

B、直接傳入通用屬性查詢對象方式。

定義：
public ExampleMatcher?withMatcher(String propertyPath, GenericPropertyMatcher genericPropertyMatcher)

產(chǎn)生效果：

向?propertySpecifiers?中增加或更新屬性“特定查詢方式”的配置。

參數(shù)說明：
propertyPath：要配置特定查詢的屬性名。
genericPropertyMatcher：直接傳入一個(gè)通用查詢對象。?ExampleMatcher.GenericPropertyMatchers工具類中提供了常用對象創(chuàng)建的靜態(tài)方法，所有方法均返回GenericPropertyMatcher?對象，所以支持鏈?zhǔn)骄幊膛渲谩?/p>

另外：GenericPropertyMatcher?類本身也提供了諸多方法，用于改變相關(guān)配置項(xiàng)。

?

C、改變的大小寫忽略方式

定義：
public ExampleMatcher?withIgnoreCase(String... propertyPaths)

產(chǎn)生效果：
向?propertySpecifiers?中增加或更新屬性“特定查詢方式”中的“大小寫忽略方式”配置。。

?

D、設(shè)置屬性轉(zhuǎn)換器

定義：
public ExampleMatcher?withTransformer(String propertyPath, PropertyValueTransformer propertyValueTransformer)

產(chǎn)生效果：
向?propertySpecifiers?中增加或更新屬性“特定查詢方式”中的“屬性轉(zhuǎn)換器”配置。

五、常用情況說明

??

1、關(guān)于基本數(shù)據(jù)類型。
實(shí)體對象中，避免使用基本數(shù)據(jù)類型，采用包裝器類型。如果已經(jīng)采用了基本類型，
而這個(gè)屬性查詢時(shí)不需要進(jìn)行過濾，則把它添加到忽略列表（ignoredPaths）中。

2、Null值處理方式。
默認(rèn)值是 IGNORE（忽略），即當(dāng)條件值為null時(shí)，則忽略此過濾條件，一般業(yè)務(wù)也是采用這種方式就可滿足。當(dāng)需要查詢數(shù)據(jù)庫表中屬性為null的記錄時(shí)，可將值設(shè)為INCLUDE，這時(shí)，對于不需要參與查詢的屬性，都必須添加到忽略列表（ignoredPaths）中，否則會出現(xiàn)查不到數(shù)據(jù)的情況。

3、默認(rèn)配置、特殊配置。
默認(rèn)創(chuàng)建匹配器時(shí)，字符串采用的是精確匹配、不忽略大小寫，可以通過操作方法改變這種默認(rèn)匹配，以滿足大多數(shù)查詢條件的需要，如將“字符串匹配方式”改為CONTAINING（包含，模糊匹配），這是比較常用的情況。對于個(gè)別屬性需要特定的查詢方式，可以通過配置“屬性特定查詢方式”來滿足要求。

4、非字符串屬性
如約束中所談，非字符串屬性均采用精確匹配，即等于。

5、忽略大小寫的問題。
忽略大小的生效與否，是依賴于數(shù)據(jù)庫的。例如 MySql 數(shù)據(jù)庫中，默認(rèn)創(chuàng)建表結(jié)構(gòu)時(shí)，字段是已經(jīng)忽略大小寫的，所以這個(gè)配置與否，都是忽略的。如果業(yè)務(wù)需要嚴(yán)格區(qū)分大小寫，可以改變數(shù)據(jù)庫表結(jié)構(gòu)屬性來實(shí)現(xiàn)，具體可百度。

??

六、常用查詢示例

以“快速入門”中的實(shí)體對象和模擬數(shù)據(jù)為例，列一些常用查詢，方便開發(fā)時(shí)參考。

?

1、無匹配器的情況
要求：查詢地址是“河南省鄭州市”，且重點(diǎn)關(guān)注的客戶。
說明：對于默認(rèn)匹配器滿足條件時(shí)，則不需要創(chuàng)建匹配器。

　　　　 //創(chuàng)建查詢條件數(shù)據(jù)對象Customer customer = new Customer();customer.setAddress("河南省鄭州市");customer.setFocus(true);//創(chuàng)建實(shí)例Example<Customer> ex = Example.of(customer); //查詢List<Customer> ls = dao.findAll(ex);//輸出結(jié)果System.out.println("數(shù)量："+ls.size());for (Customer bo:ls){System.out.println(bo.getName());}

?

輸出結(jié)果：

數(shù)量：4 李明 劉芳 zhang ming ZHANG SAN

?

2、通用情況
要求：根據(jù)姓名、地址、備注進(jìn)行模糊查詢，忽略大小寫，地址要求開始匹配。
說明：這是通用情況，主要演示改變默認(rèn)字符串匹配方式、改變默認(rèn)大小寫忽略方式、屬性特定查詢方式配置、忽略屬性列表配置。

　　　　 //創(chuàng)建查詢條件數(shù)據(jù)對象Customer customer = new Customer();customer.setName("zhang");customer.setAddress("河南省");customer.setRemark("BB");//創(chuàng)建匹配器，即如何使用查詢條件ExampleMatcher matcher = ExampleMatcher.matching() //構(gòu)建對象.withStringMatcher(StringMatcher.CONTAINING) //改變默認(rèn)字符串匹配方式：模糊查詢.withIgnoreCase(true) //改變默認(rèn)大小寫忽略方式：忽略大小寫.withMatcher("address", GenericPropertyMatchers.startsWith()) //地址采用“開始匹配”的方式查詢.withIgnorePaths("focus"); //忽略屬性：是否關(guān)注。因?yàn)槭腔绢愋?#xff0c;需要忽略掉//創(chuàng)建實(shí)例Example<Customer> ex = Example.of(customer, matcher); //查詢List<Customer> ls = dao.findAll(ex);//輸出結(jié)果System.out.println("數(shù)量："+ls.size());for (Customer bo:ls){System.out.println(bo.getName());}

?

輸出結(jié)果：?

數(shù)量：2 zhang ming ZHANG SAN

??

3、多級查詢
要求：查詢所有潛在客戶
說明：主要演示多層級屬性查詢

　　　　 //創(chuàng)建查詢條件數(shù)據(jù)對象CustomerType type = new CustomerType();type.setCode("01"); //編號01代表潛在客戶Customer customer = new Customer();customer.setCustomerType(type); //創(chuàng)建匹配器，即如何使用查詢條件ExampleMatcher matcher = ExampleMatcher.matching() //構(gòu)建對象.withIgnorePaths("focus"); //忽略屬性：是否關(guān)注。因?yàn)槭腔绢愋?#xff0c;需要忽略掉 //創(chuàng)建實(shí)例Example<Customer> ex = Example.of(customer, matcher); //查詢List<Customer> ls = dao.findAll(ex);//輸出結(jié)果System.out.println("數(shù)量："+ls.size());for (Customer bo:ls){System.out.println(bo.getName());}

?

輸出結(jié)果：?

數(shù)量：4 李明 李莉 張強(qiáng) ZHANG SAN

??

4、查詢Null值
要求：地址是null的客戶
說明：主要演示改變“Null值處理方式”

　　　　 //創(chuàng)建查詢條件數(shù)據(jù)對象Customer customer = new Customer();//創(chuàng)建匹配器，即如何使用查詢條件ExampleMatcher matcher = ExampleMatcher.matching() //構(gòu)建對象.withIncludeNullValues() //改變“Null值處理方式”：包括.withIgnorePaths("id","name","sex","age","focus","addTime","remark","customerType"); //忽略其他屬性//創(chuàng)建實(shí)例Example<Customer> ex = Example.of(customer, matcher); //查詢List<Customer> ls = dao.findAll(ex);//輸出結(jié)果System.out.println("數(shù)量："+ls.size());for (Customer bo:ls){System.out.println(bo.getName());}

?

輸出結(jié)果：?

數(shù)量：2 張強(qiáng) 劉明

?

七、寫在最后

對實(shí)例查詢的研究及本文的寫作，確入投入了精力，因此該文章也贏得了不少的點(diǎn)擊率。 但是...但是...就實(shí)用性而言，由于“實(shí)例查詢”的局限性和復(fù)雜性，在Spring Data JPA中其實(shí)是不實(shí)用的。用的最多的還是“簡單查詢”（因?yàn)楹唵?#xff0c;所以...）和 基于JPA Criteria 的動態(tài)查詢（可以滿足所有需求，沒有局限性）。（僅個(gè)人觀點(diǎn)） 簡單查詢的兩篇博文： http://www.cnblogs.com/rulian/p/6557471.html http://www.cnblogs.com/rulian/p/6434631.html

轉(zhuǎn)載于:https://www.cnblogs.com/sharpest/p/8670425.html

總結(jié)

以上是生活随笔為你收集整理的Spring Data JPA 实例查询的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。