QueryDSL：述語

QueryDSL述語は、データベースを操作するための強力で非常に柔軟なツールであり、SQLにあまり精通していない（またはまったく知識がない）Java開発者への贈り物です。







述語を使用すると、データベース要素を通常のクラスフィールドとして操作できます。 アセンブリ中に、gradleは特別な依存関係クラスを作成し、それを通してデータベースで必要なレコードが検索されます。



既にQueryDSLでの作業に成功しており、記事に対する建設的なコメントや提案があれば、喜んで読んで、必要に応じて記事で補足します。



記事の最後には、リポジトリへのリンクがあり、そこから例をクローン（またはフォーク）することができます。 私は正直にあなたに警告します-私はベースでそれをテストしませんでしたが、それがあなたのために上昇する（そして上昇する）なら、それは間違いなく動作します。 私もテストを書き始めましたが、あなたは間違いなくテストを書くでしょう、そして今日私は記事のトピック-述語を分析したいと思います。



連携するエンティティを作成します。 AbstractEntityから継承されるフィールド名と年齢およびUserGroupを持つユーザーとします。 それらの間に1対多の関係を作成しましょう-1つのグループに多くのユーザーが存在する可能性があります。 述語は、ユーザーのみによって解析されます。



AbstractEntity：

package entity; import javax.persistence.*; @MappedSuperclass public class AbstractEntity { private Long id; @Id @Column(name = "id") @SequenceGenerator(name = "general_seq", sequenceName = "generalSequenceGenerator") @GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "general_seq") public Long getId() { return id; } public void setId(Long id) { this.id = id; } @Override public boolean equals(Object o) { if (this == o) return true; if (o == null || getClass() != o.getClass()) return false; AbstractEntity that = (AbstractEntity) o; return id != null ? id.equals(that.id) : that.id == null; } @Override public int hashCode() { return id != null ? id.hashCode() : 0; } }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

ユーザー：

 package entity; import javax.persistence.*; @Entity @Table(name = "users") public class User extends AbstractEntity { private String name; private Integer age; private UserGroup group; @Column(name = "name") public String getName() { return name; } public void setName(String name) { this.name = name; } @Column(name = "age") public Integer getAge() { return age; } public void setAge(Integer age) { this.age = age; } @ManyToOne(fetch = FetchType.LAZY) @JoinColumn(name = "category") public UserGroup getGroup() { return group; } public void setGroup(UserGroup group) { this.group = group; } @Override public boolean equals(Object o) { if (this == o) return true; if (o == null || getClass() != o.getClass()) return false; if (!super.equals(o)) return false; User user = (User) o; if (name != null ? !name.equals(user.name) : user.name != null) return false; if (age != null ? !age.equals(user.age) : user.age != null) return false; return group != null ? group.equals(user.group) : user.group == null; } @Override public int hashCode() { int result = super.hashCode(); result = 31 * result + (name != null ? name.hashCode() : 0); result = 31 * result + (age != null ? age.hashCode() : 0); result = 31 * result + (group != null ? group.hashCode() : 0); return result; } }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

ユーザーグループ：

 package entity; import javax.persistence.*; import java.util.List; @Entity @Table(name = "user_groups") public class UserGroup extends AbstractEntity { private String name; private List<User> users; @Column(name = "name") public String getName() { return name; } public void setName(String name) { this.name = name; } @OneToMany(cascade = CascadeType.ALL, fetch = FetchType.LAZY, mappedBy = "group") public List<User> getUsers() { return users; } public void setUsers(List<User> users) { this.users = users; } @Override public boolean equals(Object o) { if (this == o) return true; if (o == null || getClass() != o.getClass()) return false; if (!super.equals(o)) return false; UserGroup userGroup = (UserGroup) o; if (name != null ? !name.equals(userGroup.name) : userGroup.name != null) return false; return users != null ? users.equals(userGroup.users) : userGroup.users == null; } @Override public int hashCode() { int result = super.hashCode(); result = 31 * result + (name != null ? name.hashCode() : 0); result = 31 * result + (users != null ? users.hashCode() : 0); return result; } }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

さて、エンティティがあります。今度は、リポジトリを操作するのに必要なものについて考えてみましょう。 できること：

• 必要な年齢制限内のすべてのユーザーを検索します（包含と除外の両方）。

• IDでユーザーを検索します。

• 特定のグループのすべてのユーザーと、複数のグループのユーザーを検索します。

• ユーザーを名前で検索します。

...ニーズとフィールドの数に応じて、ユーザーを好きなように検索、ソート、フィルタリングします。



QueryDSLを介してデータベースを操作するには、個別のカスタマイズされたリポジトリが必要です。 Spring JPAを介してデータベースを操作する他の場合と同じ方法でJpaRepositoryから拡張されますが、QueryDSLでカスタマイズされます。

 @NoRepositoryBean public interface ExCustomRepository<T extends AbstractEntity, P extends EntityPathBase<T>, ID extends Serializable> extends JpaRepository<T, ID>, QuerydslPredicateExecutor<T>, QuerydslBinderCustomizer<P> { @Override default void customize(QuerydslBindings bindings, P root) { } }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

重要なお知らせ。 org.springframework.data.mapping.PropertyReferenceException： Springを上げようとしたときにUserタイプのプロパティカスタマイズが見つからない場合は、 Customize（）メソッドを実装していません。 再定義するだけで十分です（カスタマイズしたくない場合）。



したがって、リポジトリを操作するには、User、QUser、およびLongを明示的に指定して、次のようにExCustomRepositoryからUserRepositoryインターフェイスを継承するだけで十分です。

 @Repository public interface UserRepository extends ExCustomRepository<User, QUser, Long> { }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

最後に、データベースにアクセスしてユーザーを検索するサービスクラスを作成します。 空の間に。

 @Service public class UserService { @Autowired UserRepository repository; //  ,   public List<User> getByAgeExcluding(Integer minAge, Integer maxAge) { } //  ,   public List<User> getByAgeIncluding(Integer minAge, Integer maxAge) { } //  ID public User getById(Long id) { } //   public List<User> getByGroups(List<UserGroup> groups) { } //   public List<User> get(String name) { } }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

Springがテーブルエンティティのオブジェクト表現を操作するには、それらの間の関係を作成する必要があります。 デフォルトでは、すべてのリンクをbuild.generated.source.apt.project_structureフォルダーに配置します。これらのリンクを作成するには、プロジェクトをクリアしてクラスを収集する必要があります。 gradleでは、これはcleanタスクとclassesタスクを順次実行することで実現されます（gradle-> Tasks-> build-> clean、classes）。 プロジェクト構造がbuild.generated.source.aptに表示され、Qプレフィックスが付いたクラスが表示されている場合、すべてを正しく実行しました。



すべてを正しく行い、上記のクラスが表示されたとします。 必要に応じて、たとえば18〜60年など、すべてのユーザーをリポジトリからリクエストしましょう。 既に述べたように、QueryDSLのテーブルエンティティ間の関係は、Qプレフィックスを持つ対応するクラスで形成されます。Userクラスの場合、これはQUserになります。 QUserはリポジトリ全体です。 ユーザー： QUser.user 、ユーザーの名前： QUser.user.name 、およびこの場合、年齢： QUser.user.ageがあります。 したがって、年齢を取得するために、 QUser.user.ageを使用します。



QueryDSLには、特定の結果を生成できる4つの主要なメソッドがあります。

• findOne（）-任意の1つの要素を検索できます。 データベースに必要なアイテムが1つしかないことを確認する必要があります。そうでない場合、覆い焼きは例外です。

• findAll（）およびそのいくつかのオーバーロード-条件を満たすレコードの反復可能なリストを返します。 通常、このリストはリストにラップする必要があります（リストがあります）。

• count（）-見つかったアイテムの数を返します。

• exists（）-そのような要素がテーブルに存在するかどうかにかかわらず、ブール値を返します。

これらのメソッドは、org.springframework.data.querydsl.QuerydslPredicateExecutorで見つけることができます。 パッケージ名からわかるように、Springはそれらを提供します。



要素の条件を満たすために、com.querydsl.core.types.dsl.SimpleExpressionに無数のメソッドが保存されています。 それらをさらに詳しく調べます。



したがって、最初の方法では、特定の年齢層のすべてのユーザーを取得する必要があります。



HQLでは、このクエリは次のようになります。

 SELECT u FROM User u WHERE u.age BETWEEN :minAge AND :maxAge
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

QueryDSLの実装では、このメソッドは次のようになります。

  public List<User> getByAgeExcluding(Integer minAge, Integer maxAge) { return Lists.newArrayList(repository.findAll(QUser.user.age.between(minAge, maxAge))); }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

年齢（ QUser.user.age ）が指定された範囲（（minAge、maxAge）の間）にあるすべてのユーザー（findAll（））を探しています。 そして、それがすべてのリクエストです。 このリクエストに応じて、ユーザーの既製リストを取得します。 SQLクエリを記述する必要はありませんが、わずかな変更で再度書き直すと、すべてが失敗します。QueryDSLは、エンティティのオブジェクト通信が提供できる最大限の柔軟性を提供します。



それはわずかな余談でしたが、まだ4つの宣言された例があります。 次の話に移りましょう。 範囲内のすべてのユーザーが見つかりましたが、選択すると境界値自体が除外されます。 検索条件に境界値を含めるには、他の方法を使用する必要があります。

• goe-以上（以上）

• loe-より小さいか等しい

取得するリクエストは次のとおりです。

  public List<User> getByAgeIncluding(Integer minAge, Integer maxAge) { return Lists.newArrayList(repository.findAll(QUser.user.age.goe(minAge).and(QUser.user.age.loe(maxAge)))); }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

この要求を満たすには、2つの条件を使用する必要があります。 これを行うには、and（）バインディングメソッドを使用します。このメソッドは、このように関連するすべての条件でフィルター処理します。 フレームワークは、最初にminAge以上のすべてのオブジェクトを選択し、次にmaxAge以下のすべてのオブジェクトを選択し、すべてを1つの要求で選択します。 そのようなバンドルは多数存在する可能性がありますが、or（）などの束もあり、それらはcom.querydsl.core.types.dsl.BooleanExpressionで見つけることができます。



次に、IDでユーザーを見つけましょう。 もちろん、これは適切なSpring JPAメソッドfindById（）を使用して行うのが最適ですが、QueryDSLを解析しているため、対応するクエリを作成します。

  public User getById(Long id) { return repository.findOne(QUser.user.id.eq(id)).orElse(new User()); }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

eq（）演算子を使用します。これは、条件に等しいフィールドで検索します（eq = equals）。



続けましょう。 私たちの場合、グループ内のすべてのユーザーを見つけるために、何も検索する必要さえありません-必要なUserGroupをそのListフィールドで取得し、複数のグループ内のすべてのユーザーを見つける必要がある場合 そして、このタスクは、QueryDSLを介した非常に簡単なクエリで実現できます。

  public List<User> getByGroups(List<UserGroup> groups) { return Lists.newArrayList(repository.findAll(QUser.user.group.in(groups))); }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

この場合、（）の演算子を使用すると、1つの値ではなく複数の検索条件を設定できます。



そして最後に、要求された名前とは異なる名前を持つすべてのユーザーを見つけます（たとえば、すべての非Ivanovs）。 リクエストは次のようになります。

  public List<User> get(String name) { return Lists.newArrayList(repository.findAll(QUser.user.name.ne(name))); }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

このクエリのおかげで、Ivana以外のすべてが見つかります。



この記事では、5つの異なるQueryDSLクエリを取り上げました。 実際のプロジェクトでは、バリエーションの数はエンティティフィールドの数とそれらの間の関係によってのみ制限できます。 QueryDSLは非常に強力であると同時に、非常に理解しやすいJavaプログラマーフレームワークです。 それを研究した後、あなたはあなた自身のコードと同じ方法でデータベースを扱うのが大好きです:)



githubでの約束された例。