Suporte multilíngue para mensagens padrão exibidas durante a validação de entrada
ambiente
- Núcleo ASP.NET
-
- 5.0 MVC
Inicialmente
O suporte multilíngue das mensagens de validação de entrada padrão com estas Dicas pode não estar completo. Por favor, lide com os que faltam.
Além disso, a alteração do idioma dependendo do estado de sessão ou do estado de cache ainda pode aparecer no texto do idioma anterior.
Existem várias maneiras de alterar a mensagem de validação de entrada padrão, cada uma das quais pode ser combinada. Não é um deles, então se você quiser mudá-lo de forma confiável, você precisa corresponder com todos os padrões.
premissa
Esta dica é escrita como entender as seguintes dicas:
- ASP.NET As características incorporadas do Core MVC para comutação multilíngue
- Suporte multilíngue para DataAnnotations usado para nomes de parâmetros, mensagens de validação de entrada, etc.
Além disso, se você está criando um novo projeto, você deve ter adicionado os seguintes arquivos e código com base em dicas acima.
- Crie um arquivo SharedResource.resx (+en, es). (Como apenas a mensagem desta Dica é traduzida, o conteúdo pode estar vazio.)
- Criar um arquivo sharedResource.cs
- Adicionar código de localização ao Startup.ConfigureServices
- Adicionar código de localização ao Startup.Configure
- Adicionado UserViewModel (desta vez, não teclamos explicitamente as mensagens padrão em vários idiomas)
- Adicionados ações e visualizações de tela criadas pelo usuário (Create.cshtml)
Código de partida
Com base nas suposições acima, cada código será o seguinte:
Startup.cs
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.AspNetCore.Localization;
using Microsoft.AspNetCore.Mvc.Razor;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
using System.Globalization;
namespace LocalizationDefaultValidation
{
public class Startup
{
// 省略
public void ConfigureServices(IServiceCollection services)
{
services.AddControllersWithViews();
services.AddMvc()
// ローカライズに必要。Resx ファイルのフォルダパスを指定
.AddViewLocalization(LanguageViewLocationExpanderFormat.Suffix, opts => { opts.ResourcesPath = "Resources"; })
// DataAnnotations のローカライズに必要
.AddDataAnnotationsLocalization(options =>
{
// DataAnnotation を使ったときのメッセージは SharedResource に集約する
options.DataAnnotationLocalizerProvider = (type, factory) => factory.Create(typeof(SharedResource));
});
}
public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
if (env.IsDevelopment())
{
app.UseDeveloperExceptionPage();
}
else
{
app.UseExceptionHandler("/Home/Error");
// The default HSTS value is 30 days. You may want to change this for production scenarios, see https://aka.ms/aspnetcore-hsts.
app.UseHsts();
}
// 標準の機能で切り替えたい言語を定義します。
var supportedCultures = new[]
{
new CultureInfo("ja"),
new CultureInfo("en"),
new CultureInfo("es"),
};
// 標準の言語切り替え機能を有効にします。対応しているのは「クエリ文字列」「Cookie」「Accept-Language HTTP ヘッダー」です。
app.UseRequestLocalization(new RequestLocalizationOptions
{
DefaultRequestCulture = new RequestCulture("ja"),
SupportedCultures = supportedCultures,
SupportedUICultures = supportedCultures
});
app.UseHttpsRedirection();
app.UseStaticFiles();
// 省略
}
}
}
HomeController.cs
using LocalizationDefaultValidation.Models;
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Mvc.Rendering;
using Microsoft.Extensions.Logging;
using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Linq;
using System.Threading.Tasks;
namespace LocalizationDefaultValidation.Controllers
{
public class HomeController : Controller
{
// 省略
public IActionResult Create()
{
SetDayOfWeeksViewData();
return View();
}
[HttpPost]
public IActionResult Create(UserViewModel model)
{
SetDayOfWeeksViewData();
// エラーなら差し戻し
if (ModelState.IsValid == false) return View(model);
// 正常に登録できた場合は Index に戻る
return RedirectToAction(nameof(Index));
}
<summary>曜日の一覧を ViewData に設定します。</summary>
private void SetDayOfWeeksViewData()
=> ViewData["DayOfWeeks"] = ((DayOfWeek[])Enum.GetValues(typeof(DayOfWeek))).Select(x => new SelectListItem(x.ToString(), ((int)x).ToString()));
}
}
Index.cshtml
@{
ViewData["Title"] = "Home Page";
}
<div class="text-center">
<h1 class="display-4">Welcome</h1>
<p>Learn about <a href="https://docs.microsoft.com/aspnet/core">building Web apps with ASP.NET Core</a>.</p>
</div>
<p>ユーザー作成画面に遷移します。リンクごとに選択した言語で表示できます。</p>
<ul>
<li><a asp-action="Create">Create</a></li>
<li><a asp-action="Create" asp-route-culture="ja">Create (ja)</a></li>
<li><a asp-action="Create" asp-route-culture="en">Create (en)</a></li>
<li><a asp-action="Create" asp-route-culture="es">Create (es)</a></li>
</ul>
Criar.cshtml
@model LocalizationDefaultValidation.Models.UserViewModel
@using System.Globalization;
@{
ViewData["Title"] = "Create";
}
<h1>Create</h1>
<h4>UserViewModel</h4>
<hr />
<div class="row">
<div class="col-md-4">
<form asp-action="Create" enctype="multipart/form-data" >
<div asp-validation-summary="ModelOnly" class="text-danger"></div>
<div class="form-group">
<label asp-for="ID" class="control-label"></label>
<input asp-for="ID" class="form-control" />
<span asp-validation-for="ID" class="text-danger"></span>
</div>
<div class="form-group">
<label asp-for="Name" class="control-label"></label>
<input asp-for="Name" class="form-control" />
<span asp-validation-for="Name" class="text-danger"></span>
</div>
<div class="form-group">
<label asp-for="Password" class="control-label"></label>
<input asp-for="Password" class="form-control" />
<span asp-validation-for="Password" class="text-danger"></span>
</div>
<div class="form-group">
<label asp-for="ConfirmPassword" class="control-label"></label>
<input asp-for="ConfirmPassword" class="form-control" />
<span asp-validation-for="ConfirmPassword" class="text-danger"></span>
</div>
<div class="form-group">
<label asp-for="Email" class="control-label"></label>
<input asp-for="Email" class="form-control" />
<span asp-validation-for="Email" class="text-danger"></span>
</div>
<div class="form-group">
<label asp-for="Age" class="control-label"></label>
<input asp-for="Age" class="form-control" />
<span asp-validation-for="Age" class="text-danger"></span>
</div>
<div class="form-group">
<label asp-for="Gender"></label>
<div>
<label><input type="radio" asp-for="Gender" value="@(GenderType.None)" />@(GenderType.None)</label>
<label><input type="radio" asp-for="Gender" value="@(GenderType.Man)" />@(GenderType.Man)</label>
<label><input type="radio" asp-for="Gender" value="@(GenderType.Woman)" />@(GenderType.Woman)</label>
</div>
<span asp-validation-for="Gender" class="text-danger"></span>
</div>
<div class="form-group">
<label asp-for="Birthday" class="control-label"></label>
<input asp-for="Birthday" class="form-control" />
<span asp-validation-for="Birthday" class="text-danger"></span>
</div>
<div class="form-group">
<label asp-for="Phone" class="control-label"></label>
<input asp-for="Phone" class="form-control" />
<span asp-validation-for="Phone" class="text-danger"></span>
</div>
<div class="form-group">
<label asp-for="PostalCode" class="control-label"></label>
<input asp-for="PostalCode" class="form-control" />
<span asp-validation-for="PostalCode" class="text-danger"></span>
</div>
<div class="form-group">
<label asp-for="CreditCard" class="control-label"></label>
<input asp-for="CreditCard" class="form-control" />
<span asp-validation-for="CreditCard" class="text-danger"></span>
</div>
<div class="form-group">
<label asp-for="Money" class="control-label"></label>
<input asp-for="Money" class="form-control" />
<span asp-validation-for="Money" class="text-danger"></span>
</div>
<div class="form-group">
<label asp-for="StartDateTime" class="control-label"></label>
<input asp-for="StartDateTime" class="form-control" />
<span asp-validation-for="StartDateTime" class="text-danger"></span>
</div>
<div class="form-group">
<label asp-for="WakeUpTime" class="control-label"></label>
<input asp-for="WakeUpTime" class="form-control" />
<span asp-validation-for="WakeUpTime" class="text-danger"></span>
</div>
<div class="form-group">
<label asp-for="Homepage" class="control-label"></label>
<input asp-for="Homepage" class="form-control" />
<span asp-validation-for="Homepage" class="text-danger"></span>
</div>
<div class="form-group">
<label asp-for="MyImage" class="control-label"></label>
<input asp-for="MyImage" class="form-control" />
<span asp-validation-for="MyImage" class="text-danger"></span>
</div>
<div class="form-group">
<label asp-for="MyColor" class="control-label"></label>
<input asp-for="MyColor" class="form-control" type="color" />
<span asp-validation-for="MyColor" class="text-danger"></span>
</div>
<div class="form-group">
<label asp-for="WorkingDays" class="control-label"></label>
<select asp-for="WorkingDays" class="form-control" asp-items="@((IEnumerable<SelectListItem>)ViewData["DayOfWeeks"])" multiple></select>
<span asp-validation-for="WorkingDays" class="text-danger"></span>
</div>
<div class="form-group">
<label asp-for="VacationDay" class="control-label"></label>
<select asp-for="VacationDay" class="form-control" asp-items="@((IEnumerable<SelectListItem>)ViewData["DayOfWeeks"])" multiple></select>
<span asp-validation-for="VacationDay" class="text-danger"></span>
</div>
<div class="form-group">
<label asp-for="Comment" class="control-label"></label>
<textarea asp-for="Comment" class="form-control"></textarea>
<span asp-validation-for="Comment" class="text-danger"></span>
</div>
<div class="form-group">
<label asp-for="FileName" class="control-label"></label>
<input asp-for="FileName" class="form-control" />
<span asp-validation-for="FileName" class="text-danger"></span>
</div>
<div class="form-group">
<label asp-for="UploadFile" class="control-label"></label>
<input asp-for="UploadFile" type="file" multiple />
<span asp-validation-for="UploadFile" class="text-danger"></span>
</div>
<div class="form-group">
<label asp-for="Month" class="control-label"></label>
<input asp-for="Month" class="form-control" type="month" />
<span asp-validation-for="Month" class="text-danger"></span>
</div>
<div class="form-group">
<label asp-for="Search" class="control-label"></label>
<input asp-for="Search" class="form-control" type="search" />
<span asp-validation-for="Search" class="text-danger"></span>
</div>
<div class="form-group">
<label asp-for="Range" class="control-label"></label>
<input asp-for="Range" class="form-control" type="range" min="10" max="100" />
<span asp-validation-for="Range" class="text-danger"></span>
</div>
<div class="form-group">
<label asp-for="Week" class="control-label"></label>
<input asp-for="Week" class="form-control" type="week" />
<span asp-validation-for="Week" class="text-danger"></span>
</div>
<div class="form-group form-check">
<label class="form-check-label">
<input class="form-check-input" asp-for="IsAccepted" /> @Html.DisplayNameFor(model => model.IsAccepted)
</label>
</div>
<div class="form-group">
<input type="submit" value="Create" class="btn btn-primary" asp-route-culture="@CultureInfo.CurrentCulture.Name" />
</div>
</form>
</div>
</div>
<div>
<a asp-action="Index">Back to List</a>
</div>
@section Scripts {
@{await Html.RenderPartialAsync("_ValidationScriptsPartial");}
}
UserViewModel.cs
using Microsoft.AspNetCore.Http;
using System;
using System.Collections.Generic;
using System.ComponentModel.DataAnnotations;
namespace LocalizationDefaultValidation.Models
{
public class UserViewModel
{
[Required]
[Display(Name = "ID (半角英数字)")]
[StringLength(20)]
[RegularExpression(@"^[0-9a-zA-Z]*$")]
public string ID { get; set; }
[StringLength(50)]
public string Name { get; set; }
[StringLength(50, MinimumLength = 8)]
[DataType(DataType.Password)]
[RegularExpression(@"^[0-9a-zA-Z]*$")]
public string Password { get; set; }
[StringLength(50, MinimumLength = 8)]
[DataType(DataType.Password)]
[Compare(nameof(Password))]
public string ConfirmPassword { get; set; }
[EmailAddress]
[DataType(DataType.EmailAddress)] // スキャフォールディングするときはコメントアウトする
public string Email { get; set; }
//[Int]
[Range(0, 150)]
public int Age { get; set; }
[Required]
[EnumDataType(typeof(GenderType))]
public GenderType Gender { get; set; }
[DataType(DataType.Date)]
public DateTime Birthday { get; set; }
[Phone()]
[DataType(DataType.PhoneNumber)] // スキャフォールディングするときはコメントアウトする
public string Phone { get; set; }
[DataType(DataType.PostalCode)]
public string PostalCode { get; set; }
[CreditCard()]
[DataType(DataType.CreditCard)] // スキャフォールディングするときはコメントアウトする
public string CreditCard { get; set; }
[DataType(DataType.Currency)]
public decimal Money { get; set; }
[DataType(DataType.DateTime)]
public DateTime StartDateTime { get; set; }
[DataType(DataType.Time)]
public TimeSpan WakeUpTime { get; set; }
[Url]
[DataType(DataType.Url)] // スキャフォールディングするときはコメントアウトする
public string Homepage { get; set; }
[Url]
[DataType(DataType.ImageUrl)] // スキャフォールディングするときはコメントアウトする
public string MyImage { get; set; }
public string MyColor { get; set; }
[MaxLength(5)]
public DayOfWeek[] WorkingDays { get; set; }
[MinLength(3)]
public DayOfWeek[] VacationDay { get; set; }
[StringLength(200)]
[DataType(DataType.MultilineText)]
public string Comment { get; set; }
[Display(Name = "ファイル名 (.png)")]
[FileExtensions(Extensions = "png")]
public string FileName { get; set; }
[DataType(DataType.Upload)]
public List<IFormFile> UploadFile { get; set; }
public DateTime Month { get; set; }
public string Search { get; set; }
[Range(10, 100)]
public int Range { get; set; }
public string Week { get; set; }
[Required]
public bool IsAccepted { get; set; }
}
public enum GenderType
{
None,
Man,
Woman,
Other,
}
}
SharedResource.cs
namespace LocalizationDefaultValidation
{
// クラス名は作成した .resx のファイル名と同じにする必要がある
public class SharedResource { }
}
Mensagens de vinculação de modelos
Se você definir o tipo de propriedade modelo int
para ou e ligá-lo à DateTime
exibição e tentar registrá-lo sem digitação, você verá uma mensagem como "O valor '' é inválido.".
Essas mensagens aparecem quando uma sequência vazia int
não pode ser vinculada, por exemplo, no modelo.
Por ser um momento que não pode ser vinculado, ele só ocorre antes de outra validação de valor e processamento do lado do servidor.
Essas mensagens são DefaultModelBindingMessageProvider
definidas como .
Startup.cs
Adicione aos argumentos do método que foram definidos desde o início services.AddControllersWithViews
em , e, em seguida, adicione Action
.
Você pode ser multilíngue definindo o aprovado no options
ModelBindingMessageProvider
argumento.
Existem 11 tipos de mensagens que você pode definir, então você deve primeiro definir a mensagem da seguinte forma: SharedResource.resx
O nome da chave é opcional. A mensagem padrão em inglês na coluna de comentários é (os comentários não devem ser incluídos).
Você não terá que traduzir cada idioma, então você deve fazer sua própria tradução (o código de amostra também inclui o SharedResource.resx traduzido).
de valor | do | nome |
---|---|---|
ModelBinding_AttemptedValueIsInvalid | '{0}' é um valor inválido no {1}. | O valor '{0}' não é válido para {1}. |
ModelBinding_MissingBindRequiredValue | O valor do {0} não está especificado. | Não foi fornecido um valor para o parâmetro ou propriedade '{0}'. |
ModelBinding_MissingKeyOrValue | Necessário. | Um valor é necessário. |
ModelBinding_MissingRequestBodyRequiredValue | O pedido deve ter um corpo. | É necessário um corpo de solicitação não vazio. |
ModelBinding_NonPropertyAttemptedValueIsInvalid | '{0}' não é válido. | O valor '{0}' não é válido. |
ModelBinding_NonPropertyUnknownValueIsInvalid | O valor não é válido. | O valor fornecido é inválido. |
ModelBinding_NonPropertyValueMustBeANumber | O número deve ser especificado. | O campo deve ser um número. |
ModelBinding_UnknownValueIsInvalid | O valor da {0} não é válido. | O valor fornecido é inválido para {0}. |
ModelBinding_ValueIsInvalid | '{0}' não é válido. | O valor '{0}' é inválido. |
ModelBinding_ValueMustBeANumber | {0} deve ser um número. | O campo {0} deve ser um número. |
ModelBinding_ValueMustNotBeNull | Entrada necessária. | O valor '{0}' é inválido. |
Corrigir a inicialização.cs da seguinte forma:
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.AspNetCore.Localization;
using Microsoft.AspNetCore.Mvc.Razor;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
using Microsoft.Extensions.Localization;
using System;
using System.Globalization;
using System.Reflection;
namespace LocalizationDefaultValidation
{
public class Startup
{
// 省略 (初期コード)
<summary>
検証メッセージローカライズで使用。
</summary>
private IServiceProvider ServiceProvider { get; set; }
private IStringLocalizer _localizer = null;
<summary>
検証メッセージローカライズで使用。
</summary>
private IStringLocalizer Localizer
=> _localizer ?? (_localizer = ServiceProvider.GetService<IStringLocalizerFactory>()
.Create(nameof(SharedResource), new AssemblyName(typeof(SharedResource).Assembly.FullName).Name));
// このメソッドはランタイムによって呼び出されます。 このメソッドを使用して、コンテナーにサービスを追加します。
public void ConfigureServices(IServiceCollection services)
{
services.AddControllersWithViews(options =>
{
// 検証メッセージのローカライズで使用
// モデルバインディング失敗時のエラーメッセージをカスタマイズ
// サーバ側でモデルに値を格納する際に発生する可能性がある
// メッセージの {0} や {1} を置換するための関数を定義
static string f1(string f, string a1) => string.Format(f, a1);
static string f2(string f, string a1, string a2) => string.Format(f, a1, a2);
// 各メソッドを読んでメッセージを置き換えます
var mp = options.ModelBindingMessageProvider;
mp.SetAttemptedValueIsInvalidAccessor((x, y) => f2(Localizer["ModelBinding_AttemptedValueIsInvalid"], x, y));
mp.SetMissingBindRequiredValueAccessor((x) => f1(Localizer["ModelBinding_MissingBindRequiredValue"], x));
mp.SetMissingKeyOrValueAccessor(() => Localizer["ModelBinding_MissingKeyOrValue"]);
mp.SetMissingRequestBodyRequiredValueAccessor(() => Localizer["ModelBinding_MissingRequestBodyRequiredValue"]);
mp.SetNonPropertyAttemptedValueIsInvalidAccessor((x) => f1(Localizer["ModelBinding_NonPropertyAttemptedValueIsInvalid"], x));
mp.SetNonPropertyUnknownValueIsInvalidAccessor(() => Localizer["ModelBinding_NonPropertyUnknownValueIsInvalid"]);
mp.SetNonPropertyValueMustBeANumberAccessor(() => Localizer["ModelBinding_NonPropertyValueMustBeANumber"]);
mp.SetUnknownValueIsInvalidAccessor((x) => f1(Localizer["ModelBinding_UnknownValueIsInvalid"], x));
mp.SetValueIsInvalidAccessor((x) => f1(Localizer["ModelBinding_ValueIsInvalid"], x));
mp.SetValueMustBeANumberAccessor((x) => f1(Localizer["ModelBinding_ValueMustBeANumber"], x));
mp.SetValueMustNotBeNullAccessor((x) => f1(Localizer["ModelBinding_ValueMustNotBeNull"], x));
});
services.AddMvc()
// ローカライズに必要。Resx ファイルのフォルダパスを指定
.AddViewLocalization(LanguageViewLocationExpanderFormat.Suffix, opts => { opts.ResourcesPath = "Resources"; })
// DataAnnotations のローカライズに必要
.AddDataAnnotationsLocalization(options =>
{
// DataAnnotation を使ったときのメッセージは SharedResource に集約する
options.DataAnnotationLocalizerProvider = (type, factory) => factory.Create(typeof(SharedResource));
});
}
// このメソッドはランタイムによって呼び出されます。 このメソッドを使用して、HTTP要求パイプラインを構成します。
public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
// ローカライズで使用するため IServiceProvider をプロパティに保持しておきます。
ServiceProvider = app.ApplicationServices;
// 標準の機能で切り替えたい言語を定義します。
var supportedCultures = new[]
{
new CultureInfo("ja"),
new CultureInfo("en"),
new CultureInfo("es"),
};
// 標準の言語切り替え機能を有効にします。対応しているのは「クエリ文字列」「Cookie」「Accept-Language HTTP ヘッダー」です。
app.UseRequestLocalization(new RequestLocalizationOptions
{
DefaultRequestCulture = new RequestCulture("ja"),
SupportedCultures = supportedCultures,
SupportedUICultures = supportedCultures
});
// 省略 (初期コード)
}
}
}
O ponto chave é services.AddControllersWithViews
adicionar a ao método que recebe option
Action
o,
options.ModelBindingMessageProvider
Estou definindo texto localizado para cada método Set em .
O texto traduzido é IStringLocalizer
recuperado de .
Não há como receber IStringLocalizer
código direto, que é um pouco de um código redondo.
SharedResource.resx
Se você está gerando código, você terá valores localizados diretamente dele.
IStringLocalizer
A chave que você especifica SharedResource.resx
especifica especifica a chave que você adicionou .
Configure-o para corresponder ao conteúdo de cada método Definir.
Além disso, como cada mensagem tem um argumento de sequência de formato, como , eu {0}{1}
uso Simples com para que você possa substituir os string.Format
Func
valores recebidos.
Localize mensagens de validação padrão
A mensagem de erro padrão quando os atributos das propriedades de Required
um modelo são definidos ou assim é determinada pelo framework e está StringLength
basicamente em inglês.
Estes podem ser IValidationAttributeAdapterProvider
localizados definindo uma classe derivada da interface.
Em primeiro SharedResource.resx
lugar, registre o texto que é multilíngue.
O nome da chave é arbitrário, mas para simplificar o programa, registre-o na forma de "nome de atributo de validação Validator_<>".
de valor | do | nome |
---|---|---|
Validator_CompareAttribute | Os {0} e {1} não combinam. | '{0}' e "{1}" não combinam. |
Validator_CreditCardAttribute | {0} não é um número de cartão válido. | O campo {0} não é um número de cartão de crédito válido. |
Validator_DataTypeAttribute_Date | Digite uma data válida. | Por favor, insira uma data válida. |
Validator_EmailAddressAttribute | {0} não é um endereço de e-mail válido. | O campo {0} não é um endereço de e-mail válido. |
Validator_FileExtensionsAttribute | {0} só aceita arquivos com as seguintes extensões: : {1} | O campo {0} só aceita arquivos com as seguintes extensões: {1} |
Validator_MaxLengthAttribute | {0} deve ser um tipo de string ou array com um comprimento máximo de '{1}'. | O campo {0} deve ser um tipo de string ou array com um comprimento máximo de '{1}'. |
Validator_MinLengthAttribute | {0} deve ser um tipo de string ou array com um comprimento mínimo de '{1}'. | O campo {0} deve ser um tipo de string ou array com um comprimento mínimo de '{1}'. |
Validator_PhoneAttribute | {0} não é um número de telefone válido. | O campo {0} não é um número de telefone válido. |
Validator_RangeAttribute | {0} deve variar de {1} a {2}. | O {0} de campo deve ser entre {1} e {2}. |
Validator_RegularExpressionAttribute | {0} deve corresponder à expressão regular "{1}". | O campo {0} deve corresponder à expressão regular "{1}". |
Validator_RequiredAttribute | {0} é necessário. | O campo {0} é necessário. |
Validator_StringLengthAttribute | {0} deve estar dentro de {1} dígitos. | O campo {0} deve ser uma sequência com um comprimento máximo de {1}. |
Validator_UrlAttribute | {0} não é uma URL válida. | O campo {0} não é um URL http, https ou ftp totalmente qualificado. |
Validator_StringLengthAttributeWithMin | {0} deve ter pelo menos {2} {1} dígitos. | O campo {0} deve ser uma sequência com um comprimento máximo de {1} e um comprimento mínimo de {2}. |
Em seguida, crie a seguinte classe AdapterProvider:
O nome da classe é arbitrário, mas desta vez CustomValidationAttributeAdapterProvider
escreverei uma aula chamada e escreverei o código da seguinte forma:
A localização do arquivo de código é arbitrária, mas a amostra é colocada em uma pasta chamada Adaptador.
using Microsoft.AspNetCore.Mvc.DataAnnotations;
using Microsoft.Extensions.Localization;
using System;
using System.ComponentModel.DataAnnotations;
namespace LocalizationDefaultValidation
{
public class CustomValidationAttributeAdapterProvider : IValidationAttributeAdapterProvider
{
<summary>コード簡略化のためのリソースキー命名規則プリフィックス</summary>
private const string RESOURCE_KEY_PREFIX = "Validator_";
private readonly IValidationAttributeAdapterProvider _fallback = new ValidationAttributeAdapterProvider();
<summary>
指定された ValidationAttribute の IAttributeAdapter を返します。
</summary>
<param name="attribute">IAttributeAdapter を作成するための ValidationAttribute。</param>
<param name="stringLocalizer">メッセージの作成に使用される IStringLocalizer。</param>
<returns>指定された属性の IAttributeAdapter。</returns>
IAttributeAdapter IValidationAttributeAdapterProvider.GetAttributeAdapter(ValidationAttribute attribute, IStringLocalizer stringLocalizer)
{
// すでにエラーメッセージが設定されている場合はそれを使用するのでここでは何も設定しない
if (attribute.ErrorMessageResourceName != null) return _fallback.GetAttributeAdapter(attribute, stringLocalizer);
// attribute には「Required」や「StringLength」などが設定されています
Type attrType = attribute.GetType();
// プリフィックスと属性のクラス名からローカライズ用のキーを生成します
var key = RESOURCE_KEY_PREFIX + attrType.Name;
// IStringLocalizer から指定したキーでローカライズされたテキストを取得します
// ない場合は getString にそのまま key の値が入ります
var getString = stringLocalizer[key];
// 正しくローカライズされたテキストが取得できた場合は ErrorMessage に値をセットします。
if (key != getString && attribute.ErrorMessage != getString)
{
attribute.ErrorMessage = getString;
}
// 設定した attribute を渡します
return _fallback.GetAttributeAdapter(attribute, stringLocalizer);
}
}
}
Se você definir as propriedades do modelo para Required
ou , o método é chamado para cada StringLength
IValidationAttributeAdapterProvider.GetAttributeAdapter
validação.
ErrorMessageResourceName
Se o imóvel contiver um valor, o código no lado do modelo já tem uma mensagem ou chave de localização, então ele retorna como está.
Se estiver vazio, combine os nomes de classe do atributo prefixo e validação para torná-lo a chave de localização e, em seguida, recupere o texto localizado da tecla e configure-o ErrorMessage
para .
Isso permite que a maioria das mensagens padrão sejam localizadas.
Em seguida, registre esta aula em .cs de startup. Basicamente, você pode adicioná-lo da seguinte forma.
// 省略
using Microsoft.AspNetCore.Mvc.DataAnnotations;
namespace LocalizationDefaultValidation
{
public class Startup
{
// 省略
// このメソッドはランタイムによって呼び出されます。 このメソッドを使用して、コンテナーにサービスを追加します。
public void ConfigureServices(IServiceCollection services)
{
// 省略
// 作成した CustomValidationAttributeAdapterProvider をシングルトンとして登録します
services.AddSingleton<IValidationAttributeAdapterProvider, CustomValidationAttributeAdapterProvider>();
}
// 省略
}
}
Executá-lo para ter certeza de que está funcionando corretamente.
Alterar uma mensagem existente por parâmetros
Por exemplo, StringLength
a mensagem de atributo é localizada, como "{0} deve estar dentro de {1} dígitos".
MinimumLength
Se a propriedade estiver definida, você pode querer alterar o {0} como "Especifique {2} dígitos ou mais {1} dentro de um número de dígitos".
Nesse CustomValidationAttributeAdapterProvider
caso, amplie a classe da seguinte forma:
// 省略
namespace LocalizationDefaultValidation
{
public class CustomValidationAttributeAdapterProvider : IValidationAttributeAdapterProvider
{
// 省略
IAttributeAdapter IValidationAttributeAdapterProvider.GetAttributeAdapter(ValidationAttribute attribute, IStringLocalizer stringLocalizer)
{
if (attribute is StringLengthAttribute slAttribute)
{
// attribute が StringLengthAttribute で MinimumLength が設定されている場合はメッセージを変える
if (slAttribute.MinimumLength >= 1)
{
attribute.ErrorMessage = stringLocalizer["Validator_StringLengthAttributeWithMin"];
return _fallback.GetAttributeAdapter(slAttribute, stringLocalizer);
}
}
// 省略
}
}
}
Como o método é chamado para cada GetAttributeAdapter
validação, se a variável passada attribute
foi StringLengthAttribute
um MinimumLength
atributo, verifique a propriedade,
Se definido, obtenha uma mensagem que também leve em conta o número mínimo de dígitos e ErrorMessage
substitui .
Se você executá-lo, verificar e a mensagem muda, está tudo bem.
Outras mensagens genéricas
Algumas mensagens não são localizadas depois que você faz até agora. Por exemplo, mensagens que são determinadas apenas em Javascript.
O alvo é jquery.validate.js
a mensagem listada no arquivo.
Como este arquivo não deve ser editado diretamente, para substituir essas mensagens por texto localizado, você input
deve adicionar um atributo semelhante à tag e definir o texto localizado data-val-XXXX
lá.
A peça XXXX contém a chave na figura jquery.validate.js
acima. (por exemplo, data-val-number
etc.)
data-val-XXXX
Para definir o texto localizado em atributos em
Vamos localizar a mensagem quando caracteres não numéricos são incluídos no campo de entrada Age como exemplo.
UserViewModel.Age
tem Range
um atributo, e a saída HTML data-val-range
anexa o atributo de entrada.
<div class="form-group">
<label class="control-label" for="Age">Age</label>
<input class="form-control" type="number" data-val="true" data-val-range="Ageは0から150の範囲で指定してください。" data-val-range-max="150" data-val-range-min="0" data-val-required="Ageは必須です。" id="Age" name="Age" value="" />
<span class="text-danger field-validation-valid" data-valmsg-for="Age" data-valmsg-replace="true"></span>
</div>
No entanto, data-val-number
a mensagem de verificação numérica não é localizada porque não há atributo.
Você adicionará outro atributo no lado do modelo para imprimir o atributo localizado adicionado por mensagens data-val-number
também.
O primeiro passo é criar uma classe de atributo que verifique se é IntAttribute
um número: É limitado a aqui, mas você é int
livre para mudá-lo dependendo da situação.
O arquivo de código pode estar em qualquer lugar, mas desta vez está na pasta Adaptador.
using System.ComponentModel.DataAnnotations;
namespace LocalizationDefaultValidation
{
public class IntAttribute : ValidationAttribute
{
public override bool IsValid(object value)
{
// 渡された値が int であれば有効な値とする
return value is int;
}
}
}
Se o valor definido é int
um tipo, é um atributo que é apenas um veredicto normal, mas na prática é 100% normal se definido para uma propriedade do tipo int, de modo que o processamento desta classe em si não faz qualquer sentido.
O objetivo deste momento é exibir mensagens de erro localizadas no cliente.
Em seguida, crie a seguinte IntAttributeAdapter
classe adaptador: Isso também está na pasta Adaptador.
using Microsoft.AspNetCore.Mvc.DataAnnotations;
using Microsoft.AspNetCore.Mvc.ModelBinding.Validation;
using Microsoft.Extensions.Localization;
namespace LocalizationDefaultValidation
{
<summary>Int 属性のアダプター。</summary>
public class IntAttributeAdapter : AttributeAdapterBase<IntAttribute>
{
<summary>受け取った IStringLocalizer を保持しておく</summary>
IStringLocalizer _stringLocalizer;
public IntAttributeAdapter(IntAttribute attribute, IStringLocalizer stringLocalizer)
: base(attribute, stringLocalizer)
{
_stringLocalizer = stringLocalizer;
}
<summary>バリデーションの追加処理として呼ばれる。</summary>
public override void AddValidation(ClientModelValidationContext context)
{
// 新たに data-val-number 属性をマージして追加します。値はローカライズしたテキストをセットします。
MergeAttribute(context.Attributes, "data-val-number", _stringLocalizer["ModelBinding_NonPropertyValueMustBeANumber"]);
}
<summary>サーバーのエラーメッセージはそのまま返します。</summary>
public override string GetErrorMessage(ModelValidationContextBase validationContext) => Attribute.ErrorMessage;
}
}
O ponto aqui é AddValidation
o método descrito no MergeAttribute
método.
Mesclando atributos como atributos da tag de entrada para retornar data-val-number
ao cliente.
O valor a ser definido no atributo define uma mensagem de erro localizada.
Devolva este adaptador na classe que você criou CustomValidationAttributeAdapterProvider
anteriormente.
// 省略
namespace LocalizationDefaultValidation
{
public class CustomValidationAttributeAdapterProvider : IValidationAttributeAdapterProvider
{
// 省略
IAttributeAdapter IValidationAttributeAdapterProvider.GetAttributeAdapter(ValidationAttribute attribute, IStringLocalizer stringLocalizer)
{
// IntAttribute の場合は IntAttributeAdapter 経由で返す
if (attribute is IntAttribute intAttribute)
{
return new IntAttributeAdapter(intAttribute, stringLocalizer);
}
// 省略 (前に追加したコード)
}
}
}
Se o valor a ser IntAttribute
validado for, retorne o que você criou IntAttributeAdapter
anteriormente.
A propriedade com o atributo Int é agora adicionada quando é exibida no lado do data-val-number
cliente.
Por fim, UserViewModel.Age
IntAttribute
adicione a .
Depois de fixar seu código, experimente-o para ver se você quer verificar.
<div class="form-group">
<label class="control-label" for="Age">Age</label>
<input class="form-control" type="number" data-val="true" data-val-number="数字を指定してください。" data-val-range="Ageは0から150の範囲で指定してください。" data-val-range-max="150" data-val-range-min="0" data-val-required="Ageは必須です。" id="Age" name="Age" value="" />
<span class="text-danger field-validation-valid" data-valmsg-for="Age" data-valmsg-replace="true"></span>
</div>
Existem outras mensagens não localizadas, mas você pode localizá-las nos métodos descritos acima. Adicione código quando precisar.