検証とページング#

検証は3段ある#

下だけ、上だけ、どちらでも使えます。

ルールを組み立てる#

ValidationRule rule = new ValidationRule()
	.empty()
	.textLengthMax(100);

積んだ順に走り、最初に落ちたところで止まります（1項目につきエラーは1件）。

列にまとめる#

ValidationRules rules = new ValidationRules()
	.put(Item.name, new ValidationRule().empty())
	.put(Item.age, new ValidationRule().integer(1, 120));

Data request = new Data();
request.putData(Item.name, "");
request.putData(Item.age, "999");

// エラーは最初の1件で止めず、全部集める（要件 F-V-03）
Data errors = rules.errors(null, request);

Data messages = ValidationMessages.toMessages(errors);

• 項目をまたいだエラーは全部集めます（1件ずつ言われるのが、入力し直す人にはいちばん困るため）
• **送られてこなかった項目は、empty()（required()）を積んだルールだけ落とします。**ほかのルールは見ません
• insertRequired() を付けたルールは「登録のときだけ必須、更新は送られたときだけ見る」です（下の「登録のときだけ必須」）
• 1つの列に配列が来たら、要素ごとに回します
• put(rule)（列なし）で、項目に紐づかない相関チェックも書けます

生のエラーの形#

errors(...) が返すのは文言ではありません。「どの種別で落ちたか」と「そのときの設定」です。

{ "validation_type": Empty, "validation_setting": {}, "input": "" }

これを人が読む形に変えるのが ValidationMessages.toMessages(errors) で、 項目名 → メッセージの一覧になります。

{ "title": ["入力してください"], "age": ["1 以上 120 以下の整数で入力してください"] }

文言を差し替える#

ValidationMessages.put(ValidationErrorType.Empty, (type, settings) -> "required");

ValidationRules rules = new ValidationRules()
	.put(Item.name, new ValidationRule().empty());

Data request = new Data();
request.putData(Item.name, "");

assertEquals(List.of("required"),
	ValidationMessages.toMessages(rules.errors(null, request)).get("name"));

止めるか、一覧を受け取るか#

ふつうは validate を文として書きます。

rules.validate(db, context.request().bodyAll());   // 通らなければここで 422
db.insert(...);

何もしなければ枠組みが 422 で返し、本文は {"validation": {"項目名": ["メッセージ"]}} ＋ 送られてきた入力値です （ValidationExecutor と同じ形）。例外なので error(...) フックは通ります（エラー処理）。 ValidationException は HttpException の子で、errors() で一覧を取り出せます。

一覧を見て自分で分岐したいときは errors(...) です。複数の束をまとめるなら Validator.validate(db, data, rules...) / Validator.errors(db, data, rules...) です。

登録のときだけ必須#

ValidationRules rules = new ValidationRules()
	.put(Item.name, new ValidationRule().insertRequired().empty())
	.insertRequestChecker(req -> req.getBoolean("is_insert"));

Data update = new Data();
update.put("is_insert", false);
assertTrue(rules.errors(null, update).isEmpty(), "更新なのに必須になっている");

Data insert = new Data();
insert.put("is_insert", true);
assertFalse(rules.errors(null, insert).isEmpty(), "登録なのに必須になっていない");

「登録リクエストかどうか」の判定は insertRequestChecker に渡します。 同じ判定が各バリデータの isInsertRequest にも届きます。

複数行を検証する#

ValidationRules rules = new ValidationRules()
	.put(Item.name, new ValidationRule().empty());

Data ok = new Data();
ok.putData(Item.name, "あ");

Data ng = new Data();
ng.putData(Item.name, "");

List<Data> errors = rules.errors(null, List.of(ok, ng, ok));

assertEquals(1, errors.size());
assertEquals(2, errors.getFirst().getInt("index"), "行番号が違う");

エラーのある行だけ返り、各行に index が入ります（1 始まり）。

validate(db, list) は、通らない行が1つでもあれば ValidationException です（例外の errors() は {"rows": [...]}）。

ルートにかける#

ValidationExecutor を継承して validate だけ書きます。

private class Failing extends ValidationExecutor {

	@Override
	protected void validate (WebContext context) {

		log.add("validate");
		addError("title", "入力してください");

	}

}

ルートではいちばん先に積みます。

JimbleApp app = new JimbleApp() {
	{
		post("/items", context -> {
			context.addExecutor(new Failing());
			context.addExecutor(new UseCase());
		});
	}
};

失敗すると、こうなります。

ValidationRules の結果をそのまま積むこともできます。

addErrors(rules.errors(db, context.request().bodyAll()));

ページング#

リクエストから読む#

Paging paging = context.request().paging();

context.request().paging(20) と書けば、per が来ていないときの既定を変えられます。 Paging は1リクエストに1つで、最初に作ったものを使い回します。先に paging() を呼んだあとで paging(50) と違う件数を渡すと IllegalStateException です。件数は最初の1回で渡してください。

SELECT にかける#

Paging paging = new Paging();
paging.load(request("2", "10"), 0);

SelectListResponse response = DBUtil.getMainDB().selectListWithRowCount(select().paging(paging));

assertEquals(10, response.list().size(), "1ページ分だけ取れていない");
assertEquals(TOTAL, response.rowCount(), "総件数が LIMIT に影響されている");

assertEquals(TOTAL, paging.totalCount());
assertEquals(3, paging.maxPage(), "25 件を 10 件ずつなら 3 ページ");
assertEquals(11, paging.start());

selectListWithRowCount が総件数の COUNT も投げます。 COUNT 文は FROM / WHERE / GROUP BY / HAVING だけを写すので、 SELECT 句や ORDER BY、LIMIT には影響されません。

取れるもの#

レスポンスに載る#

context.request().paging() を呼んだ時点でレスポンスに載ります。自分で詰め直す必要はありません。

{
  "rows": [ ... ],
  "paging": { "page": 2, "per": 10, "perAll": false,
              "maxPage": 3, "totalCount": 25, "start": 11, "count": 10 }
}

テンプレートからも同じものが見えます（${paging.page()}）。

気をつけること#

範囲外のページ（?page=999）はエラーにならず、0 件が返ります。