へっぽこプログラマーの備忘録
プログラムを中心とした個人的なメモ用のブログです。 タイトルは迷走中。
内容の保証はできませんのであしからずご了承ください。
menu
keyboard_arrow_up
Top
search
close
home
ホーム
computer
PC一般
construction
開発環境・ツール
code
プログラミング
home
ホーム
computer
PC一般
construction
開発環境・ツール
code
プログラミング
Home
›
ASP.NET Core
›
ASP.NET Core におけるバリデーションの基本
2017/11/07
ASP.NET Core におけるバリデーションの基本
update
event_note
label
ASP.NET Core
ASP.NET Core ではバリデーションをどうやってやるのかなと思い調べてみました。 基本的には属性を追加するだけで簡単にできます。
## 環境 - Visual Studio 2017 - ASP.NET Core 2.0 ## サンプル View です。 ここでは以下のような入力フォームがあったとします。 ```html @model Sample.Models.Account
Username
Password
Login
```
データクラスは以下です。 ```cs public class Account { public string Username { get; set; } public string Password { get; set; } } ``` ### 簡単な解説 まず、以下のコードで、この View で扱う model を定義しています。 ```cs @model SD2APCT1.Models.Account ``` - http://aspnet-core.clock-up.jp/contents/mvc/mvc#%E3%83%93%E3%83%A5%E3%83%BC%E4%BE%8B ここではアカウント情報を扱うためのクラス Account を model として定義しています。 入力値は `asp-for="プロパティ名"` とすることで、model の該当のプロパティにバインディングされます。 尚、大文字小文字が異なっていてもきちんとバインディングされるようです。 `asp-validation-for="プロパティ名"` は、指定したプロパティのバリデーションでエラーとなったときにメッセージを表示する箇所に指定します。 このエラーは後述するように、model とするクラスのフィールドの属性に従ってクライアントサイドでチェックされるようです。 尚、エラー以外の場合では HTML タグ自体出力されません。 `asp-validation-summary` を指定した箇所には、Controller で内容をチェックし、エラーが発生したときのメッセージが表示されます。 `asp-validation-summary` の属性値には `All` `ModelOnly` `None` が指定できるようです。 詳細は[公式のドキュメント](https://docs.microsoft.com/en-us/aspnet/core/mvc/views/working-with-forms)を参照してください。 また、メッセージは `li` タグで出力されるようです。 ## 入力を必須とする フィールドに `[Required]` を付加します。 ```cs using System.ComponentModel.DataAnnotations; public class Account { [Required] public string Username { get; set; } [Required] public string Password { get; set; } } ``` 他に指定できる属性は以下を参照してください。 - https://docs.microsoft.com/en-us/aspnet/core/mvc/models/validation#validation-attributes これに対し、アクションメソッドで以下のように記述します。 ```cs [HttpPost] [AutoValidateAntiforgeryToken] public async Task
Login(Account user) { if (ModelState.IsValid) { const string badUserNameOrPasswordMessage = "Username or password is incorrect."; if (user == null) { ModelState.AddModelError(string.Empty, badUserNameOrPasswordMessage); return View(user); } // 認証 var lookupUser = MaintenanceAccount.IsAuthentication(user); if (lookupUser == null) { ModelState.AddModelError(string.Empty, badUserNameOrPasswordMessage); return View(user); } // Cookies 認証スキームで新しい ClaimsIdentity を作成し、ユーザー名を追加します。 var identity = new ClaimsIdentity(CookieAuthenticationDefaults.AuthenticationScheme); identity.AddClaim(new Claim(ClaimTypes.Name, lookupUser.Username)); // クッキー認証スキームと、上の数行で作成されたIDから作成された新しい ClaimsPrincipal を渡します。 await HttpContext.SignInAsync(new ClaimsPrincipal(identity)); return RedirectToAction(nameof(HomeController.Index), "Home"); } return View(user); } ``` `ModelState.IsValid` により、前述の `[Required]` 属性などがチェックされて有効な値かどうかが判定できます。 この状態で未入力のままボタンをクリックすると、以下のようにエラーが表示されます。
表示するメッセージを変更したい場合は以下のように記述します。 ```cs using System.ComponentModel.DataAnnotations; public class Account { [Required(ErrorMessage = "ユーザー名は必須入力です。")] public string Username { get; set; } [Required(ErrorMessage = "パスワードは必須入力です。")] public string Password { get; set; } } ```
また、多言語対応などにより、リソースファイルからテキストを取得したい場合は以下のように記述します。 ```cs using System.ComponentModel.DataAnnotations; public class Account { [Required(ErrorMessageResourceType = typeof(Resources.Messages), ErrorMessageResourceName = "ユーザー名は必須入力です。")] public string Username { get; set; } [Required(ErrorMessageResourceType = typeof(Resources.Messages), ErrorMessageResourceName = "パスワードは必須入力です。")] public string Password { get; set; } } ``` ## 入力値に対するチェック Controller で入力値のチェックを行いエラーとする場合は、以下のように記述します。 ここでは例のため、無条件でエラーとしています。 ```cs [HttpPost] [AutoValidateAntiforgeryToken] public async Task
Login(Account user) { ModelState.AddModelError(string.Empty, "ユーザー名またはパスワードが不正です。"); return View(user); } ``` ## 参考 URL - https://qiita.com/takasan/items/205de7ac4a5f3567d7c6 - http://teruc.dnsalias.net/blog/2012/05/10/319
tweet
facebook
Pocket
B!
はてブ
LINE
chevron_left
chevron_right
Translate
Popular Posts
image
NO IMAGE
smbclient で session setup failed: NT_STATUS_LOGON_FAILURE が表示される
TortoiseGit でコミットメッセージを変更する
Docker for Windows の設定
image
NO IMAGE
マージ元ブランチとマージ先ブランチ
TortoiseGit でブランチ間の差分を見る
image
NO IMAGE
TortoiseSVN ロック状態のチェック
image
NO IMAGE
Visual Studio で文字がにじむ(ぼやける)
image
NO IMAGE
AsciidocFX をビルドする
image
NO IMAGE
PowerShellでブレークポイントが設定できない場合
[Python] 文字列の判定で、None と空文字を同時に判定する
Labels
.NET Core
31
.NET Framework
17
.NET Standard
2
AdminLTE
1
AI
1
Apache
3
AppVeyor
2
AsciiDoc
7
ASP.NET Core
55
Atom
4
AWS
5
AWS Cloud9
4
blockdiag
1
Blogger
13
Bootstrap
3
C/C++
6
C#
106
CentOS
3
Chrome
1
Chronograf
3
chrony
1
Codecov
1
CSS
1
Docker
80
DokuWiki
4
Doxygen
1
draw.io
1
EasyTag
1
Electron
1
Electron.NET
2
Entity Framework Core
9
Excel
2
FFmpeg
3
Firefox
6
Flask
1
Git
19
GitBook
4
GitBucket
7
GitHub
7
GitLab
39
Go
1
Google
1
Google Cloud Platform
1
Grafana
13
GStreamer
2
HTML
5
IIS
8
InfluxDB
14
JavaScript
15
Jekyll
2
Jenkins
7
Linux
34
Log4View
1
MahApps.Metro
3
MaterialDesignInXamlToolkit
1
MkDocs
2
MongoDB
5
MVC
1
MVVM
6
nginx
3
NLog
3
Node.js
8
npm
1
NVIDIA
3
onvif
1
OpenAPI
2
OpenCV
4
OpenSSL
3
OpenVINO
2
ownCloud
2
pandas
1
Pine Script
1
PlantUML
5
Portainer
3
PowerShell
8
Prism
2
PySide
19
Python
88
PyTorch
1
RabbitVCS
1
Razor
3
redis
1
Redmine
33
Redoc
1
remark.js
2
rocketchat
10
Ruby
3
scikit-learn
1
shotcut
1
SignalR
1
Slack
1
Socket.IO
1
SonarQube
5
Sphinx
10
SQL Server
5
SQLite
1
StableDiffusion
1
Subversion
2
Swagger
1
Swarmpit
1
Syslog
3
Telegraf
6
Tesseract
3
TestLink
2
Tomcat
2
TortoiseGit
11
TortoiseSVN
2
Trading View
1
Traefik
3
Travis CI
1
Ubuntu
31
Visual Studio
39
Visual Studio Code
10
VSCode
8
Vue.js
8
Windows
62
Windows 10
5
Windows ADK
1
Windows API
2
Windows Embedded
4
wkhtmltopdf
2
Word
3
WPF
12
WSL
5
WSL2
5
Xamarin
1
xUnit
5
yaml
1
yolo
1
アプリケーション
1
デザインパターン
1
テスト
1
バッチファイル
2
プログラミング
4
ライセンス
1
暗号資産(仮想通貨)
1
英語
2
確定申告
1
機械学習
1
強化学習
1
雑記
1
書籍
1
数学
1
正規表現
1
動画編集
1
Blog Archive
►
2024
(18)
►
9月
(5)
►
8月
(1)
►
7月
(2)
►
6月
(1)
►
4月
(2)
►
3月
(1)
►
2月
(5)
►
1月
(1)
►
2023
(30)
►
12月
(3)
►
11月
(5)
►
10月
(2)
►
9月
(1)
►
8月
(2)
►
7月
(4)
►
6月
(2)
►
5月
(3)
►
4月
(2)
►
3月
(2)
►
2月
(3)
►
1月
(1)
►
2022
(106)
►
12月
(5)
►
11月
(1)
►
10月
(3)
►
9月
(6)
►
8月
(7)
►
7月
(6)
►
6月
(13)
►
5月
(9)
►
4月
(15)
►
3月
(11)
►
2月
(14)
►
1月
(16)
►
2021
(85)
►
12月
(11)
►
11月
(6)
►
10月
(4)
►
9月
(10)
►
8月
(8)
►
7月
(4)
►
6月
(18)
►
5月
(7)
►
4月
(8)
►
3月
(2)
►
2月
(2)
►
1月
(5)
►
2020
(56)
►
12月
(1)
►
11月
(3)
►
10月
(3)
►
9月
(3)
►
8月
(3)
►
7月
(7)
►
6月
(7)
►
5月
(2)
►
4月
(6)
►
3月
(6)
►
2月
(3)
►
1月
(12)
►
2019
(92)
►
12月
(13)
►
11月
(9)
►
10月
(3)
►
9月
(2)
►
8月
(3)
►
7月
(5)
►
6月
(11)
►
5月
(6)
►
4月
(17)
►
3月
(9)
►
2月
(6)
►
1月
(8)
►
2018
(100)
►
12月
(1)
►
11月
(11)
►
10月
(8)
►
9月
(6)
►
8月
(10)
►
7月
(10)
►
6月
(8)
►
5月
(9)
►
4月
(8)
►
3月
(14)
►
2月
(4)
►
1月
(11)
▼
2017
(117)
►
12月
(14)
▼
11月
(20)
Visual Studio のビルド後イベントで配布用の ZIP ファイルを自動生成する
.NET アプリケーションを XCOPY 配置で配布する
ファイル選択ダイアログとフォルダ選択ダイアログ
GitHub と AppVeyor で .NET アプリケーションの継続的インテグレーションを行う
C# におけるコマンドライン引数の解析
Visual Studio で .NET Core + Electron.NET を使う
Firefox 57 用にアドオンのインストールと設定変更を行う
Node.js のインストールとプロキシの設定
GitLab CI で .NET Core の継続的インテグレーションを行う
GitLab をアップグレードしたら Redmine へのリンクが解除された
GitHub と Travis CI で .NET Core の継続的インテグレーションを行う
GitLab で LDAP 認証するとメールアドレスが勝手に設定されるのを直す
GitLab のバージョンアップを行った
GitLab のバックアップとリストア
Visual Studio 2017 Update 4 (15.4) で .NET Core プロジ...
ASP.NET Core におけるバリデーションの基本
[C#] 非同期メソッドを同期メソッドとして扱いたい場合
ASP.NET Core における css と js ファイルの Bundle と Minify
ASP.NET Core アプリケーションを外部に公開するための Windows ファイアウォールの設定
ASP.NET Core アプリケーションを IIS でホストする
►
10月
(17)
►
9月
(19)
►
8月
(10)
►
7月
(8)
►
6月
(3)
►
5月
(6)
►
4月
(5)
►
3月
(2)
►
2月
(8)
►
1月
(5)
►
2016
(91)
►
12月
(5)
►
11月
(9)
►
10月
(11)
►
9月
(9)
►
8月
(6)
►
7月
(14)
►
6月
(14)
►
5月
(11)
►
4月
(10)
►
3月
(2)
►
2015
(23)
►
12月
(4)
►
11月
(2)
►
10月
(8)
►
9月
(8)
►
7月
(1)
►
2013
(3)
►
11月
(1)
►
9月
(1)
►
7月
(1)
►
2012
(2)
►
7月
(1)
►
6月
(1)
►
2011
(1)
►
9月
(1)
►
2009
(1)
►
7月
(1)
►
2008
(2)
►
11月
(1)
►
7月
(1)
►
2007
(3)
►
10月
(3)