Commons Validatorがstrutsでは標準だが、このValidatorは以前apache projectの中でstrutsから分離独立したので、
他のフレームワークでも使える、ということを示唆している。
まずはテストファースト
とにかくテストを作ってみよう。EclipseのJunitを使って、クラスを作成する。とりあえずsrc/test/com/chikkun/webcms/validate/ValidateTest.java
を作成する。
作成日
最初は上記のようなひな形がeclipseによって作成される。とりあえずテストの対象となる JapaneseValidatorのインスタンスを生成するコードをsetUp()に挿入。
当然、これを入れてもコンパイルさえできない。当たり前。なんせJapaneseValidatorクラスなどないから。
そこで全く空のコンストラクターしかない、クラスをcom.chikkun.common.validator.JapaneseValidator.javaを作成。
現状でValidatorTestは
作成日
これで一応Junitはコンパイルができる。さてテストメソッドの作成。最初は全角カタカナかどうかを調べるメソッドをJunitに書き込む。
サカイカズロウ
だけど、これまたコンパイルできない。そりゃそうだ。JapaneseValidat
return falseにしたのは、trueだとテスト通っちゃうから。さて、一度右クリックでJUnitをrunさせると、当然通らない。そこで、少し書き換えよう。
の場合はそうしないと、入力があった場合にはカタカナということができない必須でカタカナの場合はで両方指定すればよい。
そんで、実行するとOK。ようし、ということで、調子ぶっこいて、ValidateTestを増やして、
サカイカズロウマチャミチャンマナブクンさかいかずろう坂井和郎ｻｶｲｶｽﾞﾛｳ
これで実行すると、うまくいくんだな、これが。ラッキー。
てなわけで気をよくして、次に同様の「ひらがな」チェックValidatorTestのメソッドと、JapaneseValidatorのメソッドを作成、テストを実行!
実際にはいっぺんにうまくいったわけじゃなく、ValidateTestのassertを考えながら、JapaneseValidatorのメソッドを修正して、少しずつ完成していく、という感じ。
時々本体のJapaneseValidatorの方のメソッドをガンガン書いちゃうことがあるけれど、本当は避けた方が良いと思う。
作成日サカイカズロウマチャミチャンマナブクンさかいかずろうさかい和郎サカイ和郎サカイかずろう坂井和郎ｻｶｲｶｽﾞﾛｳさかいかずろうまさみちゃんまなぶくんサカイカズロウさかい和郎サカイ和郎サカイかずろう坂井和郎ｻｶｲｶｽﾞﾛｳ坂井和郎小野雅巳佐藤学亜唖娃阿哀愛黑サカイカズロウさかい和郎サカイ和郎サカイかずろう坂井かずろうｻｶｲｶｽﾞﾛｳ①②③④！「」仝々♂坂井和郎小野雅巳佐藤学亜唖娃阿哀愛黑坂井和郎なのだ小野雅巳ちゃんなのだＡＢＣ町田市鶴間－１０１３ー１０ ＬＧＣ６０８号佐藤学ナノダ佐原市大倉７７９～２８いろはにほへとチリヌルヲ「坂井和郎」サカイカズロウさかい和郎サカイ和郎サカイｶｽﾞﾛｳｻｶｲかずろうｻｶｲｶｽﾞﾛｳ①②③④仝々♂
と
作成日日本語のがないので自作。
* ]]>ひらがな、カタカナ、漢字、全角一部の記号しか含まないをチェックできる。
* ]]>すべて、を返すメソッドに統一。
デフォルトコンストラクタ
カタカナかどうかをチェックする。
チェックしたい文字列
カタカナだったらを返す。
の場合はそうしないと、入力があった場合にはカタカナということができない必須でカタカナの場合はで両方指定すればよい。
ひらがなかどうかをチェックする。
チェックしたい文字列
ひらがなの場合を返す。
の場合はそうしないと、入力があった場合にはカタカナということができない必須でカタカナの場合はで両方指定すればよい。
漢字かどうかをチェックする。
チェックしたい文字列
漢字の場合を返す。
の場合はそうしないと、入力があった場合にはカタカナということができない必須でカタカナの場合はで両方指定すればよい。
全角文字かどうかをチェックする。
* ]]>ただしここで、全角文字は「漢字＋ひらがな＋カタカナ＋全角アルファベット＋全角数字＋「ー－～つの記号」＋全角スペース」。
チェックしたい文字列
ひらがなの場合を返す。
の場合はそうしないと、入力があった場合にはカタカナということができない必須でカタカナの場合はで両方指定すればよい。
ＡＺａｚ０９ー－～
とりあえず、日本語関係は(まだ考慮の余地はあるけれど)おいておいて、次に
おう、そうそうデータを保持するBeanを作っていなかった。これも作っておこうっと(本来は先にJunitからかなあ?)作るのが面倒だから、
既存のUserあたりをリファクタリング(といっても、パッケージエクスプローラでctrl-cでコピーして、testの方でctrl-vでパッケージ名は変えてくれるだけ)。
コメントや、いらないフィールドなどを削除したものが下記。
それで、次にvalidator-rules.xmlを用意してみよう。
]]>
上記を見ればわかるように、これはstrutsにおけるvalidator-rules.xmlとvalidator.xmlの両方が書いてあるという感じ。つまり、globalで定義し、fomrsetで各
validatorしたいbeanとその方法が書いている。strutsでやった人なら少なくとも、formsetの方はおなじみ。
そこで、今回は、上記のように
- loginNameが必須(文字等の指定なし)
- passも同様
- noteは必須で且つ数字(実際の備考ではそんなことはないが、ここは実験ということで)
という3つにのフィールドに対してvalidateかける。
そして、上記のglobalのクラス名(com.chikkun.webcms.commons.MyValidator)にあたり、method(validateIntなど)
に対するものを自作することになるわけです。その前にarg0にあたる、propertiesを作成します
(java/com/chikkun/common/validation.properties)。native2asciiが面倒なので、とりあえず英語で。
さて、実際のクラス(MyValidator)。最初は、まずはよく使いそうな、そしてCommons Validatorに最初からある「required」と「int」。
作成日
そして、テストケースを作成(少々手順が反対になっちゃったけど)。
作成日自動生成されたブロック
ここから実際のテスト。最初はすべての名前の名前の名前の名前最初はだけが通らないはず。
どうやら、
* ]]>のように、つ以上を指定している場合は、前のものがしていると、最後のものしか判定できないようだ。
つまり上記の場合は、はなので、はパスする。したがって、
で判定しても、うまくいかない。パスした後は判定できないようだ。
これは上記の通りうまくいかないテスト結果を表示するユーティリティメソッド
上記のソースのコメントにも書いてあるように、色々すったもんだがあったが、とりあえずテストは通った。
次に、自作した日本語のJapanseValidatorを追加しよう。
作成日
これを登録するためのvalidation.xmlのglobalとフィールドチェック用の定義を追加。今回は下にもあるように、
staffのnameが漢字で必須、quarter(部署)がひらがなで必須、nameRead(読み仮名)がカタカナで必須、emailが全角で必須という
ことにする(実際とは違うけれど)。
]]>
validation.propertiesも追加。
最後に、テストケースの追加(MyValidationTest.java)。
作成日自動生成されたブロック
ここから実際のテスト。最初はすべての名前の名前の名前の名前最初はだけが通らないはず。
どうやら、
* ]]>のように、つ以上を指定している場合は、前のものがしていると、最後のものしか判定できないようだ。
つまり上記の場合は、はなので、はパスする。したがって、
で判定しても、うまくいかない。パスした後は判定できないようだ。
これは上記の通りうまくいかない最初はのままなのですべてで引っかかる
の名前の名前の名前の名前前のは通るように。
とりあえず、に値を入れるがすべて、アスキー
とりあえず、に値を入れるがすべて、アスキー
坂井和郎サカイカズロウじんじサカイ坂井さかいテスト結果を表示するユーティリティメソッド
どうやら、一応テストに通った。
次にすでにあるCommonsも使えるように、MyValidatorとは別にFieldCheck.java作成し、validator.xmlの追加を行う。ついでに、intとrequiredも自作じゃないので、
FeieldCheck.javaに移そう。こんなときJunitを作成しておくと、簡単にチェックできるから便利だ。
まずはFieldCheck.javaから。
0) {
result = GenericTypeValidator.formatDate(value, datePattern, false);
} else if (datePatternStrict != null && datePatternStrict.length() > 0) {
result = GenericTypeValidator.formatDate(value, datePatternStrict,
true);
} else {
result = GenericTypeValidator.formatDate(value, locale);
}
} catch (Exception e) {
log.error(e.getMessage(), e);
}
}
return result;
}
public static boolean validateIntRange(Object bean, Field field) {
String value = null;
if (isString(bean)) {
value = (String) bean;
} else {
value = ValidatorUtils.getValueAsString(bean, field.getProperty());
}
if (!GenericValidator.isBlankOrNull(value)) {
try {
int intValue = Integer.parseInt(value);
int min = Integer.parseInt(field.getVarValue("min"));
int max = Integer.parseInt(field.getVarValue("max"));
if (!GenericValidator.isInRange(intValue, min, max)) {
return false;
}
} catch (Exception e) {
return false;
}
}
return true;
}
public static boolean validateDoubleRange(Object bean, Field field) {
String value = null;
if (isString(bean)) {
value = (String) bean;
} else {
value = ValidatorUtils.getValueAsString(bean, field.getProperty());
}
if (!GenericValidator.isBlankOrNull(value)) {
try {
double doubleValue = Double.parseDouble(value);
double min = Double.parseDouble(field.getVarValue("min"));
double max = Double.parseDouble(field.getVarValue("max"));
if (!GenericValidator.isInRange(doubleValue, min, max)) {
return false;
}
} catch (Exception e) {
return false;
}
}
return true;
}
public static boolean validateFloatRange(Object bean, Field field) {
String value = null;
if (isString(bean)) {
value = (String) bean;
} else {
value = ValidatorUtils.getValueAsString(bean, field.getProperty());
}
if (!GenericValidator.isBlankOrNull(value)) {
try {
float floatValue = Float.parseFloat(value);
float min = Float.parseFloat(field.getVarValue("min"));
float max = Float.parseFloat(field.getVarValue("max"));
if (!GenericValidator.isInRange(floatValue, min, max)) {
return false;
}
} catch (Exception e) {
return false;
}
}
return true;
}
public static Long validateCreditCard(Object bean, Field field) {
Long result = null;
String value = null;
if (isString(bean)) {
value = (String) bean;
} else {
value = ValidatorUtils.getValueAsString(bean, field.getProperty());
}
if (!GenericValidator.isBlankOrNull(value)) {
result = GenericTypeValidator.formatCreditCard(value);
}
return result;
}
public static boolean validateEmail(Object bean, Field field) {
String value = null;
if (isString(bean)) {
value = (String) bean;
} else {
value = ValidatorUtils.getValueAsString(bean, field.getProperty());
}
if (!GenericValidator.isBlankOrNull(value)
&& !GenericValidator.isEmail(value)) {
return false;
} else {
return true;
}
}
public static boolean validateMaxLength(Object bean, Field field) {
String value = null;
if (isString(bean)) {
value = (String) bean;
} else {
value = ValidatorUtils.getValueAsString(bean, field.getProperty());
}
if (value != null) {
try {
int max = Integer.parseInt(field.getVarValue("maxlength"));
if (!GenericValidator.maxLength(value, max)) {
return false;
}
} catch (Exception e) {
return false;
}
}
return true;
}
public static boolean validateMinLength(Object bean, Field field) {
String value = null;
if (isString(bean)) {
value = (String) bean;
} else {
value = ValidatorUtils.getValueAsString(bean, field.getProperty());
}
if (!GenericValidator.isBlankOrNull(value)) {
try {
int min = Integer.parseInt(field.getVarValue("minlength"));
if (!GenericValidator.minLength(value, min)) {
return false;
}
} catch (Exception e) {
return false;
}
}
return true;
}
protected static boolean isString(Object o) {
return (o == null) ? true : String.class.isInstance(o);
}
}
]]>
次はvalidation.xmlへの追加。
]]>
次はFieldCheck.java
0) {
result = GenericTypeValidator.formatDate(value, datePattern, false);
} else if (datePatternStrict != null && datePatternStrict.length() > 0) {
result = GenericTypeValidator.formatDate(value, datePatternStrict,
true);
} else {
result = GenericTypeValidator.formatDate(value, locale);
}
} catch (Exception e) {
log.error(e.getMessage(), e);
}
}
return result;
}
public static boolean validateIntRange(Object bean, Field field) {
String value = null;
if (isString(bean)) {
value = (String) bean;
} else {
value = ValidatorUtils.getValueAsString(bean, field.getProperty());
}
if (!GenericValidator.isBlankOrNull(value)) {
try {
int intValue = Integer.parseInt(value);
int min = Integer.parseInt(field.getVarValue("min"));
int max = Integer.parseInt(field.getVarValue("max"));
if (!GenericValidator.isInRange(intValue, min, max)) {
return false;
}
} catch (Exception e) {
return false;
}
}
return true;
}
public static boolean validateDoubleRange(Object bean, Field field) {
String value = null;
if (isString(bean)) {
value = (String) bean;
} else {
value = ValidatorUtils.getValueAsString(bean, field.getProperty());
}
if (!GenericValidator.isBlankOrNull(value)) {
try {
double doubleValue = Double.parseDouble(value);
double min = Double.parseDouble(field.getVarValue("min"));
double max = Double.parseDouble(field.getVarValue("max"));
if (!GenericValidator.isInRange(doubleValue, min, max)) {
return false;
}
} catch (Exception e) {
return false;
}
}
return true;
}
public static boolean validateFloatRange(Object bean, Field field) {
String value = null;
if (isString(bean)) {
value = (String) bean;
} else {
value = ValidatorUtils.getValueAsString(bean, field.getProperty());
}
if (!GenericValidator.isBlankOrNull(value)) {
try {
float floatValue = Float.parseFloat(value);
float min = Float.parseFloat(field.getVarValue("min"));
float max = Float.parseFloat(field.getVarValue("max"));
if (!GenericValidator.isInRange(floatValue, min, max)) {
return false;
}
} catch (Exception e) {
return false;
}
}
return true;
}
public static Long validateCreditCard(Object bean, Field field) {
Long result = null;
String value = null;
if (isString(bean)) {
value = (String) bean;
} else {
value = ValidatorUtils.getValueAsString(bean, field.getProperty());
}
if (!GenericValidator.isBlankOrNull(value)) {
result = GenericTypeValidator.formatCreditCard(value);
}
return result;
}
public static boolean validateEmail(Object bean, Field field) {
String value = null;
if (isString(bean)) {
value = (String) bean;
} else {
value = ValidatorUtils.getValueAsString(bean, field.getProperty());
}
if (!GenericValidator.isBlankOrNull(value)
&& !GenericValidator.isEmail(value)) {
return false;
} else {
return true;
}
}
public static boolean validateMaxLength(Object bean, Field field) {
String value = null;
if (isString(bean)) {
value = (String) bean;
} else {
value = ValidatorUtils.getValueAsString(bean, field.getProperty());
}
if (value != null) {
try {
int max = Integer.parseInt(field.getVarValue("maxlength"));
if (!GenericValidator.maxLength(value, max)) {
return false;
}
} catch (Exception e) {
return false;
}
}
return true;
}
public static boolean validateMinLength(Object bean, Field field) {
String value = null;
if (isString(bean)) {
value = (String) bean;
} else {
value = ValidatorUtils.getValueAsString(bean, field.getProperty());
}
if (!GenericValidator.isBlankOrNull(value)) {
try {
int min = Integer.parseInt(field.getVarValue("minlength"));
if (!GenericValidator.minLength(value, min)) {
return false;
}
} catch (Exception e) {
return false;
}
}
return true;
}
protected static boolean isString(Object o) {
return (o == null) ? true : String.class.isInstance(o);
}
public static boolean validateUrl(Object bean, Field field) {
String value = null;
if (isString(bean)) {
value = (String) bean;
} else {
value = ValidatorUtils.getValueAsString(bean, field.getProperty());
}
if (GenericValidator.isBlankOrNull(value)) {
return true;
}
// Get the options and schemes Vars
boolean allowallschemes = "true".equalsIgnoreCase(field
.getVarValue("allowallschemes"));
int options = allowallschemes ? UrlValidator.ALLOW_ALL_SCHEMES : 0;
if ("true".equalsIgnoreCase(field.getVarValue("allow2slashes"))) {
options += UrlValidator.ALLOW_2_SLASHES;
}
if ("true".equalsIgnoreCase(field.getVarValue("nofragments"))) {
options += UrlValidator.NO_FRAGMENTS;
}
String schemesVar = allowallschemes ? null : field.getVarValue("schemes");
// No options or schemes - use GenericValidator as default
if (options == 0 && schemesVar == null) {
if (GenericValidator.isUrl(value)) {
return true;
} else {
return false;
}
}
// Parse comma delimited list of schemes into a String[]
String[] schemes = null;
if (schemesVar != null) {
StringTokenizer st = new StringTokenizer(schemesVar, ",");
schemes = new String[st.countTokens()];
int i = 0;
while (st.hasMoreTokens()) {
schemes[i++] = st.nextToken().trim();
}
}
// Create UrlValidator and validate with options/schemes
UrlValidator urlValidator = new UrlValidator(schemes, options);
if (urlValidator.isValid(value)) {
return true;
} else {
return false;
}
}
}
]]>
これに対するテストケース。もともとあるものだし、面倒なのでintRange、email、mask,url,date,maxlengthの6つをテストしてみようと思う。
validation.xmlの書き方は書き方を参考に。
allowallschems
true
mask
^[a-zA-Z]*$
datePattern
yyyy-mm-dd
min
4
max
16
maxlength
10
]]>
test/com/chikkun/webcms/validagtor/CommonsValidatorTest.javaの作成。
作成日自動生成されたブロック
じゃないもの
の名前として正しい
文字は駄目
の名前文字
の間
範囲外・未満の名前範囲内範囲外・より大きいでもでも可
datePattern]]>をdatePatternStrict]]>にすれば
は不可
当然駄目
の名前