DTO中是否有用于数据转换的注释？

如何解决DTO中是否有用于数据转换的注释？

我想创建一个.NET Core REST API，用作两个系统之间的代理。接收系统采用特定值，而发送系统则采用不同的变体。

在下面的示例中，接收系统需要以下类型为string的性别密钥

• 男性
• 女性
• 多样化
• 未定义

发送系统可能会发送“男性”的变体形式，例如“ m”。如果DTO中的值为“ m”，我想将其转换为“ male”。如果键不通，它应该只发送回400。我知道我可以创建验证属性，但是我也可以创建转换属性吗？

也许我可以直接在属性中转换DTO值？

这是我当前的示例，展示了我想要实现的目标

[AttributeUsage(AttributeTargets.Field | AttributeTargets.Property)]
public class MyValidationAttribute : System.ComponentModel.DataAnnotations.ValidationAttribute
{
    public override bool IsValid(object value)
    {
        if (value != null)
        {
            string key = value.ToString();

            switch (key)
            {
                case "male":
                case "m":
                    key = "male"; // Transform the value from the DTO here
                    break;
                case "female":
                case "f":
                    key = "female"; // ...
                    break;
                
                // ...

                default:
                    return false; // Throw 400 because the value didn't match
            }
        }

        return false;
    }

    public override string FormatErrorMessage(string name) => "... Invalid ...";
}

解决方法

您可以在DTO中为您的字段创建一个自定义转换器。假设您的代码中包含某种性别枚举，则可以引入custom属性来列举枚举值的可能值。例如DescriptionsAttribute：

using System;

[AttributeUsage(AttributeTargets.Field,AllowMultiple = false)]
public class DescriptionsAttribute : Attribute
{
    public DescriptionsAttribute(params string[] values)
    {
        Values = values ?? throw new ArgumentNullException(nameof(values));
    }

    public string[] Values { get; }
}

此属性实现将允许您在枚举中为每个值添加一个至多个描述。然后，您可以使用此自定义属性来描述Gender枚举中的字段。我留下了Undefined值，没有刻意进行任何描述，因为我打算稍后将其用作备用值，但是您可以根据需要进行更改。

public enum Gender
{
    [Descriptions("m","male")]
    Male,[Descriptions("f","female")]
    Female,[Descriptions("d","diverse")]
    Diverse,Undefined
}

您还需要某种方法来从枚举字段中提取DescriptionsAttribute值。我已经将该逻辑封装在扩展方法中。

using System;
using System.Linq;
using System.Reflection;

public static class EnumExtensions
{
    public static T GetAttribute<T>(this Enum value) where T : Attribute
    {
        string stringValue = value.ToString();

        MemberInfo memberInfo = value
            .GetType()
            .GetMember(stringValue)
            .FirstOrDefault();

        return memberInfo?
            .GetCustomAttributes(typeof(T),false)
            .Cast<T>()
            .FirstOrDefault();
    }
}

完成此操作后，即可提供自定义JsonConverter<Gender>实现。在以下示例中，我允许不区分大小写的Gender匹配，并在没有适当匹配的情况下将Undefined作为后备值。

using System;
using System.Linq;
using System.Text.Json;
using System.Text.Json.Serialization;

public class GenderConverter : JsonConverter<Gender>
{
    public override Gender Read(ref Utf8JsonReader reader,Type typeToConvert,JsonSerializerOptions options)
    {
        string value = reader.GetString();

        foreach (Gender gender in Enum.GetValues(typeof(Gender)))
        {
            string[] descriptions = gender.GetAttribute<DescriptionsAttribute>()?.Values;

            if (descriptions != null &&
                descriptions.Any(description => description.Equals(value,StringComparison.OrdinalIgnoreCase)))
            {
                return gender;
            }
        }

        return Gender.Undefined;
    }

    public override void Write(Utf8JsonWriter writer,Gender value,JsonSerializerOptions options)
    {
        writer.WriteStringValue(value.ToString());
    }
}

最后，您只需要用适当的Gender实现用法来装饰DTO中的JsonConverter属性。

using System.Text.Json.Serialization;

public class SomeDto
{
    [JsonConverter(typeof(GenderConverter))]
    public Gender Gender { get; set; }
}