spring Data JPA 集成solr7（二）

2.1. Query lookup strategies

The Solr module supports defining a query manually as String or have it being derived from the method name. NOTE: There is no QueryDSL Support present at this time.

Declared queries

Deriving the query from the method name is not always sufficient and/or may result in unreadable method names. In this case one might make either use of Solr named queries (see Using NamedQueries ) or use the @Query annotation (see Using @Query Annotation ).

2.2. Query creation

Generally the query creation mechanism for Solr works as described in Query methods . Here’s a short example of what a Solr query method translates into:

Example 54. Query creation from method names

public interface ProductRepository extends Repository<Product, String> {
  List<Product> findByNameAndPopularity(String name, Integer popularity);
}

The method name above will be translated into the following solr query

q=name:?0 AND popularity:?1

A list of supported keywords for Solr is shown below.

Table 2. Supported keywords inside method names

Keyword	Sample	Solr Query String
And	findByNameAndPopularity	q=name:?0 AND popularity:?1
Or	findByNameOrPopularity	q=name:?0 OR popularity:?1
Is	findByName	q=name:?0
Not	findByNameNot	q=-name:?0
IsNull	findByNameIsNull	q=-name:[* TO *]
IsNotNull	findByNameIsNotNull	q=name:[* TO *]
Between	findByPopularityBetween	q=popularity:[?0 TO ?1]
LessThan	findByPopularityLessThan	q=popularity:[* TO ?0}
LessThanEqual	findByPopularityLessThanEqual	q=popularity:[* TO ?0]
GreaterThan	findByPopularityGreaterThan	q=popularity:{?0 TO *]
GreaterThanEqual	findByPopularityGreaterThanEqual	q=popularity:[?0 TO *]
Before	findByLastModifiedBefore	q=last_modified:[* TO ?0}
After	findByLastModifiedAfter	q=last_modified:{?0 TO *]
Like	findByNameLike	q=name:?0*
NotLike	findByNameNotLike	q=-name:?0*
StartingWith	findByNameStartingWith	q=name:?0*
EndingWith	findByNameEndingWith	q=name:*?0
Containing	findByNameContaining	q=name:*?0*
Matches	findByNameMatches	q=name:?0
In	findByNameIn(Collection<String> names)	q=name:(?0…​ )
NotIn	findByNameNotIn(Collection<String> names)	q=-name:(?0…​ )
Within	findByStoreWithin(Point, Distance)	q={!geofilt pt=?0.latitude,?0.longitude sfield=store d=?1}
Near	findByStoreNear(Point, Distance)	q={!bbox pt=?0.latitude,?0.longitude sfield=store d=?1}
Near	findByStoreNear(Box)	q=store[?0.start.latitude,?0.start.longitude TO ?0.end.latitude,?0.end.longitude]
True	findByAvailableTrue	q=inStock:true
False	findByAvailableFalse	q=inStock:false
OrderBy	findByAvailableTrueOrderByNameDesc	q=inStock:true&sort=name desc

Collections types can be used along with 'Like', 'NotLike', 'StartingWith', 'EndingWith' and 'Containing'.

Page<Product> findByNameLike(Collection<String> name);

2.3. Using @Query Annotation

Using named queries ( Using NamedQueries ) to declare queries for entities is a valid approach and works fine for a small number of queries. As the queries themselves are tied to the Java method that executes them, you actually can bind them directly using the Spring Data Solr @Query annotation.

Example 55. Declare query at the method using the  @Query annotation.

public interface ProductRepository extends SolrRepository<Product, String> {
  @Query("inStock:?0")
  List<Product> findByAvailable(Boolean available);
}

2.4. Using NamedQueries

Named queries can be kept in a properties file and wired to the accroding method. Please mind the naming convention described in Query Lookup Strategies or use @Query .

Example 56. Declare named query in properties file

Product.findByNamedQuery=popularity:?0
Product.findByName=name:?0

public interface ProductRepository extends SolrCrudRepository<Product, String> {

  List<Product> findByNamedQuery(Integer popularity);

  @Query(name = "Product.findByName")
  List<Product> findByAnnotatedNamedQuery(String name);

}

3.2.1. Query lookup strategies

The Solr module supports defining a query manually as String or have it being derived from the method name. NOTE: There is no QueryDSL Support present at this time.

Declared queries

Deriving the query from the method name is not always sufficient and/or may result in unreadable method names. In this case one might make either use of Solr named queries (see Using NamedQueries ) or use the @Query annotation (see Using @Query Annotation ).

3.2.2. Query creation

Generally the query creation mechanism for Solr works as described in Query methods . Here’s a short example of what a Solr query method translates into:

Example 54. Query creation from method names

public interface ProductRepository extends Repository<Product, String> {
  List<Product> findByNameAndPopularity(String name, Integer popularity);
}

The method name above will be translated into the following solr query

q=name:?0 AND popularity:?1

A list of supported keywords for Solr is shown below.

Table 2. Supported keywords inside method names

Keyword	Sample	Solr Query String
And	findByNameAndPopularity	q=name:?0 AND popularity:?1
Or	findByNameOrPopularity	q=name:?0 OR popularity:?1
Is	findByName	q=name:?0
Not	findByNameNot	q=-name:?0
IsNull	findByNameIsNull	q=-name:[* TO *]
IsNotNull	findByNameIsNotNull	q=name:[* TO *]
Between	findByPopularityBetween	q=popularity:[?0 TO ?1]
LessThan	findByPopularityLessThan	q=popularity:[* TO ?0}
LessThanEqual	findByPopularityLessThanEqual	q=popularity:[* TO ?0]
GreaterThan	findByPopularityGreaterThan	q=popularity:{?0 TO *]
GreaterThanEqual	findByPopularityGreaterThanEqual	q=popularity:[?0 TO *]
Before	findByLastModifiedBefore	q=last_modified:[* TO ?0}
After	findByLastModifiedAfter	q=last_modified:{?0 TO *]
Like	findByNameLike	q=name:?0*
NotLike	findByNameNotLike	q=-name:?0*
StartingWith	findByNameStartingWith	q=name:?0*
EndingWith	findByNameEndingWith	q=name:*?0
Containing	findByNameContaining	q=name:*?0*
Matches	findByNameMatches	q=name:?0
In	findByNameIn(Collection<String> names)	q=name:(?0…​ )
NotIn	findByNameNotIn(Collection<String> names)	q=-name:(?0…​ )
Within	findByStoreWithin(Point, Distance)	q={!geofilt pt=?0.latitude,?0.longitude sfield=store d=?1}
Near	findByStoreNear(Point, Distance)	q={!bbox pt=?0.latitude,?0.longitude sfield=store d=?1}
Near	findByStoreNear(Box)	q=store[?0.start.latitude,?0.start.longitude TO ?0.end.latitude,?0.end.longitude]
True	findByAvailableTrue	q=inStock:true
False	findByAvailableFalse	q=inStock:false
OrderBy	findByAvailableTrueOrderByNameDesc	q=inStock:true&sort=name desc

Collections types can be used along with 'Like', 'NotLike', 'StartingWith', 'EndingWith' and 'Containing'.

Page<Product> findByNameLike(Collection<String> name);

3.2.3. Using @Query Annotation

Using named queries ( Using NamedQueries ) to declare queries for entities is a valid approach and works fine for a small number of queries. As the queries themselves are tied to the Java method that executes them, you actually can bind them directly using the Spring Data Solr @Query annotation.

Example 55. Declare query at the method using the  @Query annotation.

public interface ProductRepository extends SolrRepository<Product, String> {
  @Query("inStock:?0")
  List<Product> findByAvailable(Boolean available);
}

3.2.4. Using NamedQueries

Named queries can be kept in a properties file and wired to the accroding method. Please mind the naming convention described in Query Lookup Strategies or use @Query .

Example 56. Declare named query in properties file

Product.findByNamedQuery=popularity:?0
Product.findByName=name:?0

public interface ProductRepository extends SolrCrudRepository<Product, String> {

  List<Product> findByNamedQuery(Integer popularity);

  @Query(name = "Product.findByName")
  List<Product> findByAnnotatedNamedQuery(String name);

}