WebSurfer's Home

トップ > Blog 1   |   Login
Filter by APML

CustomValidation 属性

by WebSurfer 25. February 2020 16:09

ASP.NET MVC アプリケーションでモデルのプロパティにまたがるユーザー入力の検証に用いる CustomValidation 属性の実装方法を備忘録として書いておきます。

CustomValidation 属性

個々のプロパティのユーザー入力の検証には、下のサンプルコードの例のように Required, StringLength, Range などのデータアノテーション属性を利用するのが便利です。

加えて、上の画像のように苗字が佐藤の場合は年齢が 20 歳以上でなければならないという条件(例としてあまり適切ではないかもしれませんが)を付けたい場合はどうするかという話です。

その目的に使えるのが CustomValidation 属性です。プロパティにまたがる検証を行い、検証結果 NG の場合は新しい ModelState ディクショナリにエラーを追加して、既存の ModelState ディクショナリにマージするという操作を行います。(他に IValidatableObject を継承したカスタムモデルを使う方法もあります。それについては別の記事「IValidatableObject を継承したカスタムモデル」を見てください)

CustomValidation 属性には、パラメータとしてデータ型とメソッド名を指定します。データ型はこの属性を付与するモデルの型とします。メソッドは下のサンプルコードのシグネチャを持つ public static メソッドとします。

CustomVaidation 属性をモデルに付与する場合とプロパティに付与する場合とではコードが異なりますので注意してください。下のサンプルコードで、前者がモデルに付与する場合で、後者かプロパティに付与する場合です。

// 下の using 句は ASP.NET Core の場合。.NET Framework
// の MVC5 の場合は若干異なるので注意。namespace 以下
// のコードは Core / .NET Framework 同じになる。
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using System.ComponentModel.DataAnnotations;
using System.Text.RegularExpressions;
using Microsoft.AspNetCore.Mvc.ModelBinding;
using System.Globalization;

namespace MvcCoreApp.Models
{
  // モデルレベル
  [CustomValidation(typeof(CustomValidationModel2), 
                           "ValidateNameAndAge")]
  public class CustomValidationModel2
  {
    public int PersonId { set; get; }

    [Display(Name = "名前")]
    [Required(ErrorMessage = "{0} は必須入力")]
    [StringLength(20, ErrorMessage = 
      "{0} は {2} から {1} 文字の範囲", MinimumLength = 2)]
    public string Name { set; get; }

    [Display(Name = "メールアドレス")]
    [Required(ErrorMessage = "{0} は必須入力")]
    [EmailAddress(ErrorMessage = 
        "有効な Email 形式ではありません")]
    public string Mail { set; get; }

    [Display(Name = "年齢")]
    [Required(ErrorMessage = "{0} は必須入力")]
    [Range(0, 200, ErrorMessage = 
        "{0} は {1} から {2} の範囲")]
    public int Age { set; get; }

    // 以下のシグネチャを持つ public static メソッド:
    // public static ValidationResult ValidateNameAndAge(
    //                     CustomValidationModel2 model)
    // または
    public static ValidationResult ValidateNameAndAge(
                             CustomValidationModel2 model, 
                             ValidationContext context)
    {
      if (model == null)
      {
        throw new NullReferenceException();
      }

      if (model.Name.StartsWith("佐藤") && model.Age < 20)
      {
        return new ValidationResult(
            "佐藤さんは二十歳以上でなければなりません");     
      }
      else
      {
        return ValidationResult.Success;
      }            
    }
  }

  // プロパティレベル
  public class CustomValidationModel3
  {
    public int PersonId { set; get; }

    [Display(Name = "名前")]
    [Required(ErrorMessage = "{0} は必須入力")]
    [StringLength(20, ErrorMessage = 
      "{0} は {2} から {1} 文字の範囲", MinimumLength = 2)]
    public string Name { set; get; }

    [Display(Name = "メールアドレス")]
    [Required(ErrorMessage = "{0} は必須入力")]
    [EmailAddress(ErrorMessage = 
        "有効な Email 形式ではありません")]
    public string Mail { set; get; }

    [Display(Name = "年齢")]
    [Required(ErrorMessage = "{0} は必須入力")]
    [Range(0, 200, ErrorMessage = 
        "{0} は {1} から {2} の範囲")]
    [CustomValidation(typeof(CustomValidationModel3), 
        "ValidateNameAndAge")]
    public int Age { set; get; }

    // 引数 age には年齢が int 型の値として代入される
    public static ValidationResult ValidateNameAndAge(int age,
                                 ValidationContext context)
    {
      var model = 
        context.ObjectInstance as CustomValidationModel3;
      if (model == null)
      {
        throw new NullReferenceException();
      }

      if (model.Name.StartsWith("佐藤") && age < 20)
      {
        return new ValidationResult(
            "佐藤さんは二十歳以上でなければなりません");
      }
      else
      {
        return ValidationResult.Success;
      }
    }
  }
}

この記事の画像はプロパティレベルの場合で、エラーメッセージもプロパティレベルで表示されています。モデルレベルの場合はエラーメッセージはサマリーに表示されます。

Tags: , ,

CORE

カスタムモデルバインダ (Core 3.1)

by WebSurfer 15. February 2020 14:34

ASP.NET Core 3.1 MVC アプリケーションでカスタムモデルバインダを利用するコードを備忘録として書いておきます。(注:.NET Framework の MVC ではありません)

カスタムモデルバインダ (Core 3.1)

先の記事「カスタムモデルバインダ (MVC5)」で .NET Framework の MVC5 のカスタムモデルバインダのコードを書きましたが、それと同じ機能を ASP.NET Core 3.1 MVC で実装してみます。

モデルバインド機能だけでなく、先の MVC5 版の記事と同様に、ユーザー入力の検証とエラーメッセージの表示ができるようにしました。

カスタムモデルバインダが継承するインターフェイスは Microsoft.AspNetCore.Mvc.ModelBinding 名前空間に属する IModelBinder Interface となります。MVC5 用と名前は同じですが中身が異なることに注意してください。

実装するのは BindModelAsync(ModelBindingContext) という Task を返す非同期メソッドになります。

加えて、ヘルパーメソッドで使っている GetValue(key) メソッドが返す ValueProviderResult は MVC5 と Core で名前は同じながら別物で、Core 用は ValueProviderResult 構造体となります。ユーザーから POST されてきた値は FirstValue プロパティを使って文字列として取得します。

Model, カスタムモデルバインダ、Controller のサンプルコードを以下にアップしておきます。上の画像を表示したものです。View のコードはスキャフォールディング機能を使って自動生成できるので割愛します。

モデルとカスタムモデルバインダ

モデルのコードは MVC5 用と全く同じです。カスタムモデルバインダのコードは上に述べた点が異なりますが、他は MVC5 用と同じです。

using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using System.ComponentModel.DataAnnotations;
using System.Text.RegularExpressions;
using Microsoft.AspNetCore.Mvc.ModelBinding;
using System.Globalization;

namespace MvcCoreApp.Models
{
  // モデル(MVC5 用と同じ)
  public class Person2
  {
    public int PersonId { set; get; }

    [Display(Name = "名前")]
    public string Name { set; get; }

    [Display(Name = "メールアドレス")]
    public string Mail { set; get; }

    // int? 型にしないと未入力に対応できない
    [Display(Name = "年齢")]
    public int? Age { set; get; }
  }

  // カスタムモデルバインダ
  public class CustomModelBinder : IModelBinder
  {
    public Task BindModelAsync(ModelBindingContext context)
    {
      if (context == null)
      {
        throw new ArgumentNullException("context");
      }

      var model = new Person2();
      model.Name = PostedData(context, "Name");
      model.Mail = PostedData(context, "Mail");
      string age = PostedData(context, "Age");

      if (string.IsNullOrEmpty(age))
      {
        context.ModelState.AddModelError("Age", 
                                         "年齢は必須");
      }
      else
      {
        int intAge = 0;
        if (!int.TryParse(age, out intAge))
        {
          context.ModelState.AddModelError("Age", 
                                         "年齢は整数");
        }
        else
        {
          model.Age = intAge;
          if (intAge < 0 || intAge > 200)
          {
            context.ModelState.AddModelError("Age", 
                           "年齢は 0 ~ 200 の範囲");
          }
        }
      }

      if (string.IsNullOrEmpty(model.Name))
      {
        context.ModelState.AddModelError("Name", 
                                         "名前は必須");
      }
      else if (model.Name.Length < 2 || 
               model.Name.Length > 20)
      {
        context.ModelState.AddModelError("Name", 
                            "名前は 2 ~ 20 文字の範囲");
      }
      else if (model.Name.StartsWith("佐藤") && 
               model.Age < 20)
      {
        context.ModelState.AddModelError("", 
             "佐藤さんは二十歳以上でなければなりません");
      }

      if (string.IsNullOrEmpty(model.Mail))
      {
        context.ModelState.AddModelError("Mail", 
                                 "メールアドレスは必須");
      }
      else
      {
        bool isValidEmai = Regex.IsMatch(model.Mail,
            @"・・・正規表現(省略)・・・",
            RegexOptions.IgnoreCase, 
            TimeSpan.FromMilliseconds(250));

        if (!isValidEmai)
        {
          context.ModelState.AddModelError("Mail", 
                    "有効な Email 形式ではありません");
        }
      }

      context.Result = ModelBindingResult.Success(model);
      return Task.CompletedTask;
    }

    // ヘルパーメソッド
    // GetValue(key) メソッドが返す ValueProviderResult は
    // MVC5 と Core では別物。前者はクラスで後者は構造体。
    // 値を取得するには FirstValue プロパティを使う
    private static string PostedData(
        ModelBindingContext context, string key)
    {
      var result = context.ValueProvider.GetValue(key);
      context.ModelState.SetModelValue(key, result);
      return result.FirstValue;
    }
  }
}

Controller / Action Method

MVC5 の場合と同様に、モデルバインダをターゲットとなる型に関連付けるため、POST データを受けるアクションメソッドの引数に [ModelBinder(typeof(CustomModelBinder))] を付与します。

using System;
using Microsoft.AspNetCore.Mvc;
using MvcCoreApp.Models;

namespace MvcCoreApp.Controllers
{
  public class ValidationController : Controller
  {
    public IActionResult Create4()
    {
      return View();
    }

    [HttpPost]
    [ValidateAntiForgeryToken]
    public IActionResult Create4(
      [ModelBinder(typeof(CustomModelBinder))] Person2 model)
    {
      if (!ModelState.IsValid)
      {
        return View(model);
      }

      return RedirectToAction("Index", "Home");
    }
  }
}

Tags: , , ,

CORE

カスタムモデルバインダ (MVC5)

by WebSurfer 14. February 2020 15:29

.NET Framework の ASP.NET MVC5 アプリケーションでカスタムモデルバインダを利用するコードを備忘録として書いておきます。(注:ASP.NET Core 3.1 MVC の記事は「カスタムモデルバインダ (Core 3.1)」を見てください。下のサンプルコードは ASP.NET Core MVC には使えません)

カスタムモデルバインダ

モデルバインド機能だけでなく、ユーザー入力の検証とエラーメッセージの表示ができるようにしてみました。

上の画像を表示する Model と Controller のサンプルコードを以下にアップしておきます。View のコードはスキャフォールディング機能を使って自動生成できるので省略します。

Model とカスタムモデルバインダ

using System;
using System.Collections.Generic;
using System.Text.RegularExpressions;
using System.ComponentModel.DataAnnotations;
using System.Web.Mvc;
using System.Globalization;

namespace Mvc5App.Models
{
  // Model
  public class Person2
  {
    public int PersonId { set; get; }

    [Display(Name = "名前")]
    public string Name { set; get; }

    [Display(Name = "メールアドレス")]
    public string Mail { set; get; }

    // Age は int? にしないと未入力ではカスタムモデルバイ
    // ンダでも動かない。既定のモデルバインダと同様に null
    // が渡されて例外がスローされるようで「年齢 フィールド
    // が必要です。 」というエラーメッセージが表示される
    [Display(Name = "年齢")]
    public int? Age { set; get; }
  }

  // カスタムモデルバインダー
  public class CustomModelBinder : IModelBinder
  {
    public object BindModel(ControllerContext contContext, 
                          ModelBindingContext bindContext)
    {
      if (bindContext == null)
      {
        throw new ArgumentNullException("引数が null");
      }

      var model = new Person2();
      model.Name = PostedData<string>(bindContext, "Name");
      model.Mail = PostedData<string>(bindContext, "Mail");
      // ここでは string 型で取得する
      string age = PostedData<string>(bindContext, "Age");

      if (string.IsNullOrEmpty(age))
      {
        bindContext.ModelState.AddModelError("Age", 
                                           "年齢は必須");
      }
      else
      {
        int intAge;
        if (!int.TryParse(age, out intAge))
        {
          bindContext.ModelState.AddModelError("Age",
                                            "年齢は整数");
        }
        else
        {
          model.Age = intAge;
          if (intAge < 0 || intAge > 200)
          {
            bindContext.ModelState.AddModelError("Age", 
                                "年齢は 0 ~ 200 の範囲");
          }
        }
      }

      if (string.IsNullOrEmpty(model.Name))
      {
        bindContext.ModelState.AddModelError("Name",
                                            "名前は必須");
      }
      else if (model.Name.Length < 2 || 
               model.Name.Length > 20)
      {
        bindContext.ModelState.AddModelError("Name",
                             "名前は 2 ~ 20 文字の範囲");
      }

      else if (model.Name.StartsWith("佐藤") &&
               model.Age < 20)
      {
        bindContext.ModelState.AddModelError("",
              "佐藤さんは二十歳以上でなければなりません");
      }

      if (string.IsNullOrEmpty(model.Mail))
      {
        bindContext.ModelState.AddModelError("Mail",
                                  "メールアドレスは必須");
      }
      else
      {
        bool isValidEmai = Regex.IsMatch(model.Mail,
          @"・・・正規表現(省略)・・・",
          RegexOptions.IgnoreCase, 
          TimeSpan.FromMilliseconds(250));

        if (!isValidEmai)
        {
          bindContext.ModelState.AddModelError("Mail", 
                        "有効な Email 形式ではありません");
        }
      }

      return model;
    }

    // ヘルパーメソッド
    // Core では ValueProviderResult.ConvertTo メソッドは使え
    // ませんので注意。
    private static T PostedData<T>(ModelBindingContext context,
                                   string key)
    {
      var result = context.ValueProvider.GetValue(key);
      context.ModelState.SetModelValue(key, result);
      return (T)result.ConvertTo(typeof(T));
    }
  }
}

Controller / Action Method

モデルバインダをターゲットとなる型に関連付けるため、POST データを受けるアクションメソッドの引数に [ModelBinder(typeof(CustomModelBinder))] を付与します。(これはローカルな関連付けで、Global.asax の Application_Start メソッドでグローバルに関連付けを行うこともできるそうです)

using System;
using System.Web.Mvc;
using Mvc5App.Models;

namespace Mvc5App.Controllers
{
  public class ValidationController : Controller
  {
    // カスタムモデルバインダーを使ったサンプル
    public ActionResult Create4()
    {
      return View();
    }

    [HttpPost]
    [ValidateAntiForgeryToken]
    public ActionResult Create4(
      [ModelBinder(typeof(CustomModelBinder))] Person2 model)
    {
      if (!ModelState.IsValid)
      {
        return View(model);
      }

      return RedirectToAction("Index", "Home");
    }
  }
}

Tags: , ,

MVC

About this blog

2010年5月にこのブログを立ち上げました。その後 ブログ2 を追加し、ここは ASP.NET 関係のトピックス、ブログ2はそれ以外のトピックスに分けました。

Calendar

<<  April 2020  >>
MoTuWeThFrSaSu
303112345
6789101112
13141516171819
20212223242526
27282930123
45678910

View posts in large calendar