検索条件の組み立て

このレッスンでは、指定された条件だけを WHERE 句に足していく動的クエリの考え方を身に付けます。

検索フォームは条件が毎回変わります

利用者向けの検索画面を思い浮かべてください。名前で絞り込みたい人もいれば、年齢だけで絞りたい人もいて、何も入れずに一覧を見たい人もいます。つまりリクエストごとに、使われる条件の組み合わせが変わります。

この状況をメソッド名クエリで表そうとすると行き詰まります。findByName、findByMinAge、findByNameAndMinAge、findAll の4つを用意しなければならず、条件が1つ増えるたびに必要なメソッド数が倍になります。条件が5つあれば32通りです。名前で列挙する方式は、この時点で限界を迎えます。

指定されたものだけを足す

解き方は単純です。条件を最初から全部書くのではなく、指定されているものだけを順に足していきます。

ここで大事なのは、条件をいったんリストに集めてから最後にまとめてつなぐ、という順序です。文字列に直接足していく書き方をすると、AND を先頭に付けるべきか否かの判定が条件ごとに必要になり、必ず事故が起きます。よくある失敗は次の2つです。

1. 条件が1つも無いのに WHERE だけが残り、SELECT * FROM users WHERE という壊れた SQL になる
2. 先頭の条件の前に AND が付いて WHERE AND name = ? になる

リストに集める方式なら、どちらも構造的に起こりません。区切り文字を挟むのは要素と要素の間だけ、という仕事を String.join に任せられるからです。

未指定をどう表すか

実務でつまずきやすいのが「未指定」の表現です。Spring の @RequestParam(required = false) を Integer で受ければ未指定は null になりますが、int で受けると未指定でも 0 が入ってしまい、区別が付きません。文字列も同様で、パラメータそのものが来ない場合と、空文字列で来た場合の両方を未指定として扱うのが普通です。

Spring 本体では、この分岐をより宣言的に書くための Specification や Query by Example といった仕組みも用意されていますが、内部でやっていることは今書いた「指定された条件だけを足す」という判断そのものです。

演習で書くもの

演習では、この組み立てを自分の手で書きます。name と minAge を受け取り、指定されたものだけを含む WHERE 句を作ります。今回は引数に null を使えないので、name は空文字列を、minAge は -1 を未指定の印として扱います。どちらも未指定なら WHERE 句そのものを付けない、という判定が肝です。Spring が Specification の内側でやっている判断を、そのまま条件分岐として書き下すことになります。

1. name が空文字列でなければ name = 'taro' の形の条件を足すこと。値はシングルクォートで囲むこと
2. minAge が -1 でなければ age >= 20 の形の条件を足すこと
3. 条件が2つあるときは name の条件を先にして AND でつなぎ、条件が1つも無いときは WHERE 句を付けないこと