アノテーションインターフェース OrderBy

リポジトリメソッドにアノテーションを付けて、結果の並べ替えをリクエストします。

リポジトリメソッドに複数の OrderBy アノテーションが指定されている場合、ソートの優先順位は OrderBy アノテーションが指定された順序に従い、その後は Sort パラメーターまたは任意の Order パラメーターによって動的に提供されるソート条件に従います。

たとえば、次の例では、まず lastName 属性で昇順で並べ替え、次に同じ lastName を持つエンティティについては、firstName 属性でこれも昇順で並べ替えます。同じ lastName と firstName を持つエンティティの場合。

 @OrderBy("lastName")
 @OrderBy("firstName")
 @OrderBy("id")
 Person[] findByZipCode(int zipCode, PageRequest pageRequest);
 

昇順と降順の解釈はデータベースによって決まりますが、一般的には次のようになります。

• 数値の昇順は、小さい数値が大きな数値の前に来る自然な順序です。
• 文字列値の昇順は辞書式順序であり、A が Z より前
• ブール値の昇順では、false が true の前に配置されます。

@OrderBy アノテーションを持つリポジトリメソッドには、次のものを含めることはできません。

• メソッド名によるクエリ OrderBy キーワードを名前に含めず
• ORDER BY 句を含む JDQL または JPQL クエリを指定する @Query アノテーション。

Jakarta Data プロバイダーは、コンパイル時にこのようなリポジトリメソッド宣言を拒否するか、UnsupportedOperationExceptionSE をスローするメソッドを実装することができます。

データベースがリクエストされた並べ替え条件で順序付けできない場合、リポジトリメソッドは DataException またはより具象サブクラスで失敗します。