Blazorise项目中的表单验证本地化处理指南-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00272/article/details/148577872

Blazorise项目中的表单验证本地化处理指南

Blazorise 项目地址: https://gitcode.com/gh_mirrors/bla/Blazorise

引言

在开发多语言Web应用时，表单验证信息的本地化是一个常见需求。Blazorise作为一款功能强大的Blazor组件库，提供了灵活的验证机制和本地化支持。本文将详细介绍如何在Blazorise项目中实现验证信息的本地化处理。

基础验证示例

让我们从一个简单的验证示例开始。假设我们有一个包含电话号码国家代码的表单字段，需要使用正则表达式进行验证：

<Validations @ref=_validationsRef HandlerType="ValidationHandlerType.DataAnnotation" Model="_model">
    <Validation>
        <Field>
            <FieldLabel>电话号码国家代码</FieldLabel>
            <TextEdit @bind-Text="@_model.PhoneCountryCode">
                <Feedback>
                    <ValidationError />
                </Feedback>
            </TextEdit>
        </Field>
    </Validation>
</Validations>

对应的模型类使用了DataAnnotations进行验证：

public class ValidationLocalizationExample
{
    [RegularExpression(@"^(\+?\d{1,3}|\d{1,4})$")]
    public string PhoneCountryCode { get; set; }
}

默认情况下，验证失败时会显示英文错误信息，包含两个参数：

验证失败的字段名称
验证使用的正则表达式

验证本地化的挑战

当我们需要将错误信息显示为其他语言时，就需要使用Blazorise提供的MessageLocalizer功能。这是一个可以设置在Validation组件上的参数，用于本地化验证失败时显示的错误信息。

MessageLocalizer工作原理

MessageLocalizer是一个委托类型，签名为：

Func<string, IEnumerable<string>? arguments, string>

它接收错误消息和对应的参数(如果有)，返回本地化的错误消息。通过提供符合此签名的委托，我们可以实现消息的本地化。

实现自定义MessageLocalizer

为了更灵活地处理本地化，我们可以创建一个辅助类，利用.NET的IStringLocalizer来实现本地化功能：

public class MessageLocalizerHelper<T>
{
    private readonly IStringLocalizer<T> _stringLocalizer;

    public MessageLocalizerHelper(IStringLocalizer<T> stringLocalizer)
    {
        _stringLocalizer = stringLocalizer;
    }

    public string Localize(string message, IEnumerable<string>? arguments)
    {
        try
        {
            return arguments?.Any() == true
                ? _stringLocalizer[message, LocalizeMessageArguments(arguments)?.ToArray()!]
                : _stringLocalizer[message];
        }
        catch
        {
            return _stringLocalizer[message];
        }
    }

    private IEnumerable<string> LocalizeMessageArguments(IEnumerable<string> arguments)
    {
        foreach (var argument in arguments)
        {
            // 首先尝试使用"DisplayName:{Name}"格式查找本地化
            var localization = _stringLocalizer[$"DisplayName:{argument}"];

            if (localization.ResourceNotFound)
            {
                // 如果找不到，则直接使用参数名称查找
                localization = _stringLocalizer[argument];
                yield return localization;
            }
        }
    }
}

这个辅助类提供了以下功能：

基本的消息本地化
参数本地化处理
多种本地化键尝试机制
错误处理

完整实现示例

将自定义的MessageLocalizer应用到验证组件中：

<Validations @ref=_validationsRef HandlerType="ValidationHandlerType.DataAnnotation" Model="_model">
    <Validation MessageLocalizer="MessageLocalizer.Localize">
        <Field>
            <FieldLabel>电话号码国家代码</FieldLabel>
            <TextEdit @bind-Text="@_model.PhoneCountryCode">
                <Feedback>
                    <ValidationError />
                </Feedback>
            </TextEdit>
        </Field>
    </Validation>
</Validations>

@code {
    [Inject] public MessageLocalizerHelper<Dashboard> MessageLocalizer { get; set; }
    
    // 其余代码...
}