web-dev-qa-db-ja.com

Spring Data RESTで高度な検索を行う方法

私の仕事は、Spring Data RESTで高度な検索を行うことです。どうすれば実装できますか?

次のような簡単な検索を行うメソッドを作成できました。

public interface ExampleRepository extends CrudRepository<Example, UUID>{

    @RestResource(path="searchByName", rel="searchByName")
    Example findByExampleName(@Param("example") String exampleName);

}

この例は、単にURLにアクセスする必要がある場合に完全に機能します。

.../api/examples/search/searchByName?example=myExample

しかし、検索するフィールドが複数ある場合はどうすればよいですか?

たとえば、Exampleクラスに5つのフィールドがある場合、すべての可能性フィールドで高度な検索を行うにはどの実装が必要ですか?

これを考えてください:

.../api/examples/search/searchByName?filed1=value1&field2=value2&field4=value4

そしてこれは:

.../api/examples/search/searchByName?filed1=value1&field3=value3

この検索を適切な方法で実装するにはどうすればよいですか?

ありがとう。

13
Alessandro C

クエリメソッドの実装は、 Springreferencedocumentation とたくさんの技術ブログで広く文書化されていますが、かなりの数が古くなっています。

あなたの質問はおそらく「ひどい多くのfindBy *メソッドを宣言せずにフィールドの組み合わせでマルチパラメータ検索を実行できますか?」であるため、答えは Querydsl であり、これは-

7
Marc Tarin

Spring Data RestはQueryDSLとWebサポートを統合しており、高度な検索要件に使用できます。リポジトリを変更してQueryDslPredicateExecutorを実装する必要があります。すぐに動作します。

以下は、この機能に関する blog 記事のサンプルです。

$ http :8080/api/stores?address.city=York    
{
    "_embedded": {
        "stores": [
            {
                "_links": {
                    …
                }, 
                "address": {
                    "city": "New York", 
                    "location": { "x": -73.938421, "y": 40.851 }, 
                    "street": "803 W 181st St", 
                    "Zip": "10033-4516"
                }, 
                "name": "Washington Hgts/181st St"
            }, 
            {
                "_links": {
                    …
                }, 
                "address": {
                    "city": "New York", 
                    "location": { "x": -73.939822, "y": 40.84135 }, 
                    "street": "4001 Broadway", 
                    "Zip": "10032-1508"
                }, 
                "name": "168th & Broadway"
            }, 
            …
        ]
    }, 
    "_links": {
        …
    }, 
    "page": {
        "number": 0, 
        "size": 20, 
        "totalElements": 209, 
        "totalPages": 11
    }
}
7
Faisal Feroz

このタスクの実用的なソリューションを見つけました。

@RepositoryRestResource(excerptProjection=MyProjection.class)
public interface MyRepository extends Repository<Entity, UUID> {

    @Query("select e from Entity e "
          + "where (:field1='' or e.field1=:field1) "
          + "and (:field2='' or e.field2=:field2) "
          // ...
          + "and (:fieldN='' or e.fieldN=:fieldN)"
    Page<Entity> advancedSearch(@Param("field1") String field1,
                               @Param("field2") String field2,
                               @Param("fieldN") String fieldN,
                               Pageable page);

}

このソリューションでは、このベースURLを使用します。

http://localhost:8080/api/examples/search/advancedSearch

必要なすべてのフィールドで高度な検索を行うことができます。

いくつかの例:

http://localhost:8080/api/examples/search/advancedSearch?field1=example
    // filters only for the field1 valorized to "example"

http://localhost:8080/api/examples/search/advancedSearch?field1=name&field2=surname
    // filters for all records with field1 valorized to "name" and with field2 valorized to "surname"
3
Alessandro C

Query by Example を使用してこれを実装できました。

次のモデルがあるとしましょう:

@Entity
public class Company {

  @Id
  @GeneratedValue
  Long id;

  String name;
  String address;

  @ManyToOne
  Department department;

}


@Entity
public class Department {

  @Id
  @GeneratedValue
  Long id;

  String name;

}

そしてリポジトリ:

@RepositoryRestResource
public interface CompanyRepository extends JpaRepository<Company, Long> {
}

JpaRepositoryQueryByExampleExecutor を実装していることに注意してください)。

次に、カスタムコントローラーを実装します。

@RepositoryRestController
@RequiredArgsConstructor
public class CompanyCustomController {

  private final CompanyRepository repository;

  @GetMapping("/companies/filter")
  public ResponseEntity<?> filter(
      Company company,
      Pageable page,
      PagedResourcesAssembler assembler,
      PersistentEntityResourceAssembler entityAssembler
  ){

    ExampleMatcher matcher = ExampleMatcher.matching()
        .withIgnoreCase()
        .withStringMatcher(ExampleMatcher.StringMatcher.CONTAINING);

    Example example = Example.of(company, matcher);

    Page<?> result = this.repository.findAll(example, page);

    return ResponseEntity.ok(assembler.toResource(result, entityAssembler));

  }
}

そして、次のようなクエリを作成できます。

localhost:8080/companies/filter?name=google&address=NY

次のようなネストされたエンティティをクエリすることもできます。

localhost:8080/companies/filter?name=google&department.name=finances

簡潔にするために一部の詳細を省略しましたが、Githubで 実行例 を作成しました。

0
Jefferson Lima

あなたは次のことを試すことができると思います:

List<Person> findDistinctPeopleByLastnameOrFirstname(@Param("lastName")String lastname, @Param("firstName")String firstname);

およびexamples/search/searchByLastnameOrFirstname?firstName=value1&lastName=value2

チェックアウト: http://docs.spring.io/spring-data/jpa/docs/current/reference/html/#repositories.query-methods.query-creation

0