スポンサーリンク

「C#」DataAnnotationsとは?

概要

クラスのプロパティに仕掛けることによって、チェックができる。

Laravelのvalidationのような感じと思います。

例

// DTO等のデータを保持するクラス
public class UserData
{
    // プロパティ
    [RegularExpression(
        @"^[ -~]*$",
        ErrorMessage = "パスワードは半角英数字記号で入力してください。")]
    [StringLength(16, ErrorMessage = "パスワードは16文字以内で入力してください。")]
    Password { get; set; } 
}
// 上記のクラスのデータをチェックする処理
var userData = new UserData();
userData.Password = "abcdefg"
var context = new ValidationContext(userData );
var results = new List<ValidationResult>();

bool ok = Validator.TryValidateObject(
    userData ,
    context,
    results,
    true);

if (!ok)
{
    // チェックに引っかかった場合
    string errorMessages = string.Join("\n", results.Select(r => r.ErrorMessage));
    throw new Exception($"ユーザー情報の入力値に不備があります。\n{errorMessages}");
}

効果

Validatorの配置がめんどくさくはありますが、プロパティの可読性が向上しますし、チェック処理を実装するよりははるかにめんどくさくありません。

こんなのあるの知りませなんだ・・・。
引き続きDataAnnotationsの種類がわかれば更新していこうと思います。

チェック属性

  • Required        (必須)
  • StringLength(100)    (100文字以内)
  • RegularExpression()   (正規表現)
    例)@”^[ -~]*$”     (半角英数記号のみ)
  • EmailAddress      (メールアドレス)
    ただし、空文字でも引っかかる上に日本のメールアドレスはRFCに準拠していないので使わない方が良いかもしれません。(確かimode時代のDocomoがぶっ壊した記憶があります、imode時代は無双してましたもんね・・・。)
    半角英数字記号判定で良いと思います、日本のご当地ドメイン(全角)は世界的に未対応のところが多いようです。