创建一个非空的GUID验证属性和一个非默认的验证属性

在本文中，我将描述一个方便的验证属性，该属性在ASP.NET Core模型绑定期间用于验证GUID没有默认值Guid.Empty。我总是发现自己在项目中重新创建它，所以现在我可以从这里复制它！

为什么需要一个非空的验证属性？
您可能想知道为什么“非空”属性是必需的。这与Required属性不一样吗？假设您在API控制器上有一个可更新用户名的操作方法。例如：

[ApiController]
public class UserController: Controller
{
[HttpPut("/user/name")]
public IActionResult UpdateName(UpdateNameModel model)
{
if(!ModelState.IsValid)
{
return BadReques(ModelState);
}

    _userService.UpdateName(model);

    return Ok();
}

}
此方法将请求的主体绑定到一个UpdateNameModel对象，该对象包含Id要更新的用户的名称以及该用户的新名称：

public class UpdateNameModel
{
public Guid Id { get; set; }

[Required(AllowEmptyStrings = false)]
[StringLength(100)]
public string Name { get; set; }

}
就像您期望的那样，string Name使用[Required]属性将The标记为必需，并且具有用于字符串长度的验证属性。现在，我们知道该Id属性也是必需的，但是如何用ValidationAttributes实现呢？显而易见的答案是添加该[Required]属性，但是不幸的是，该方法不起作用。

该[Required]属性检查装饰的属性是否不为null。不过Guid是一个结构，这将永远不会为空，很像int，DateTime和其他结构值。这意味着无论请求主体是否包含值，该值Id将始终具有值。如果Id未提供，则它将具有default值，该forGuid值为全零（也显示为Guid.Empty）：

00000000-0000-0000-0000-000000000000
因此，添加[Required]属性不会Id实现任何效果。该属性将始终表示Id合法。相反，您有几种选择：

使用BindRequired以确保值Id在请求主体提供了依据。Filip在此对这种方法有很好的描述。
使该属性可为空。如果使用aGuid?而不是a，Guid则该值可以为null，因此添加Required属性确认其不为null。这行得通，但对我来说却很笨拙。
Guid运行其他验证后，或通过使用，手动检查其是否为空IValidatableObject。对于这样一个简单的验证要求，这似乎是混乱和过大的。
创建一个自定义属性。
这篇文章的目标是能够将验证属性应用于Id模型的属性，以验证其具有非空/非默认值。例如

public class UpdateNameModel
{
[NotEmpty]
public Guid Id { get; set; }
public string Name { get; set; }
}
在NotEmptyAttribute对Guid小号
我们需要的属性具有以下特征：

对于Guid属性：返回对除以下任何值均有效的值Guid.Empty
对于Guid?属性：返回对除以外的任何值均有效。请注意，它应该返回有效的值-如果该值应不为或为空，使用两个属性： Guid.Emptynullnull[Required, NotEmpty]
对于所有其他类型：所有值都应该有效，包括在内null，因为此属性对非Guid属性没有意义。这里的行为本质上是未定义的，因此您可以根据需要使属性始终返回无效。
以下属性满足所有这些属性：

[AttributeUsage(
AttributeTargets.Property | AttributeTargets.Field | AttributeTargets.Parameter,
AllowMultiple = false)]
public class NotEmptyAttribute : ValidationAttribute
{
public const string DefaultErrorMessage = “The {0} field must not be empty”;
public NotEmptyAttribute() : base(DefaultErrorMessage) { }

public override bool IsValid(object value)
{
    //NotEmpty doesn't necessarily mean required
    if (value is null)
    {
        return true;
    }

    switch (value)
    {
        case Guid guid:
            return guid != Guid.Empty;
        default:
            return true;
    }
}

}
您可以将此属性添加到先前描述的UpdateNameModel模型中，以防止中的空值Id。请注意，这既可以防止请求主体不包含的值Id的情况，也可以防止提供明确的空值（即全零）的Guid情况。

public class UpdateNameModel
{
[NotEmpty]
public Guid Id { get; set; }

[Required(AllowEmptyStrings = false)]
[StringLength(100)]
public string Name { get; set; }

}
NotDefaultAttribute一般的for结构
该[NotEmpty]属性是我通常需要的属性，因为ID值通常以Guids形式提供，并且Guid.Empty很少使用。但是，您可能想对其他结构使用类似的方法。例如，您可能希望aDateTime不具有默认值DateTime.MinValue。

一种选择是为您关心的每个结构创建不同的属性，例如NotMinValueAttribute对于的情况DateTime。另外，我们可以创建一个更通用的属性，该属性可以应用于任何结构。

在一般情况下，我们不比较特定值（Guid.Empty或DateTime.MinValue），而是比较default该数据类型的值和。为了与其他验证属性保持一致，我们不会将验证应用于null值-null除非您也应用了该Required属性，否则值将始终有效。

注意：我尚未对该属性进行广泛的测试，这只是我编写该NotEmpty属性时所考虑的！它假定可以创建默认值的实例，因此非公共类型或包含泛型参数的类型将导致运行时异常。您可能不太可能在公共模型中使用这些类型，但要记住这一点。

public class NotDefaultAttribute : ValidationAttribute
{
public const string DefaultErrorMessage = “The {0} field must not have the default value”;
public NotDefaultAttribute() : base(DefaultErrorMessage) { }

public override bool IsValid(object value)
{
    //NotDefault doesn't necessarily mean required
    if (value is null)
    {
        return true;
    }

    var type = value.GetType();
    if (type.IsValueType)
    {
        var defaultValue = Activator.CreateInstance(type);
        return !value.Equals(defaultValue);
    }

    // non-null ref type
    return true;
}

}
NotEmpty如您所料，整体结构与属性非常相似。我们首先检查null，如果是这种情况，则返回true。

要查找默认值，我们需要得到运行时Type所提供的value使用GetType()。如果我们有一个值类型（如Guid或DateTime），则可以Activator.CreateInstance()用来创建该类型的默认值。然后，我们可以将提供value的defaultValue与进行比较，false如果匹配则返回。如果类型不是值类型（因此是引用类型），则我们已经知道该类型不具有default值（null），因此我们返回true。

一个有趣的一点是，由于此方法使用的值的各种拳，你必须使用Equals()方法，没有对==和!=比较值到其默认时，运营商。您可以在以下测试中看到不执行此操作的结果。

public class NotDefaultTests
{
[Fact]
public void WhenEmpty_NotValid()
{
var validator = new NotDefaultAttribute();

    var isValid = validator.IsValid(Guid.Empty);

    Assert.False(isValid); // Fails if you use != instead of !value.Equals(defaultValue)
}

}
还值得指出的是，如果您使用FluentValidation，则内置NotEmpty()验证器已经可以处理默认值（和null）。

概要
在这篇文章中，我描述了一个[NotEmpty]验证属性，该属性可用于检测何时Guid将模型上的属性绑定到默认值Guid.Empty。这可能是因为值根本没有绑定模型，或者是默认绑定了默认值的模型。我还展示了一个更通用的属性版本，用于验证结构没有其默认值。

原文链接：创建一个非空的GUID验证属性和一个非默认的验证属性: https://andrewlock.net/creating-an-empty-guid-validation-attribute/