在Web.API控制器中自动反序列化为类似字符串的类

时间：2015-12-21 16:26:10

标签： c# json asp.net-web-api deserialization asp.net-web-api2

我有一个Web.API端点，它将这样的对象作为参数：

public class Person
{
    public string FirstName { get; set; }
    public string LastName { get; set; }
    public int Age { get; set; }
    public UserName UserName { get; set; }
}

例如：

[Route("api/person")]
[AcceptVerbs("POST")]
public void UpdatePerson(Person person)
{
    // etc.
}

（这只是一个例子 - 我们实际上并没有通过我们的Web.API端点接受用户名）

我们的UserName类是一个定义string隐式运算符的对象，所以我们在整个应用程序中对string的处理方式完全一样。

不幸的是，Web.API并不自动知道如何将相应的JavaScript Person对象反序列化为C＃Person对象 - 反序列化的C＃Person对象始终为null。例如，我可以使用jQuery从我的JavaScript前端调用此端点：

$.ajax({
    type: 'POST',
    url: 'api/test',
    data: { FirstName: 'First', LastName: 'Last', Age: 110, UserName: 'UserName' }
});

如果我不使用UserName属性，则data参数会正确反序列化为C＃Person对象（UserName属性设置为null ）。

如何让Web.API将JavaScript对象上的UserName属性正确反序列化为自定义UserName类？

这是我的UserName课程的样子：

public class UserName
{
    private readonly string value;
    public UserName(string value)
    {
        this.value = value;
    }
    public static implicit operator string (UserName d)
    {
        return d != null ? d.ToString() : null;
    }
    public static implicit operator UserName(string d)
    {
        return new UserName(d);
    }
    public override string ToString()
    {
        return value != null ? value.ToUpper().ToString() : null;
    }

    public static bool operator ==(UserName a, UserName b)
    {
        // If both are null, or both are same instance, return true.
        if (System.Object.ReferenceEquals(a, b))
            return true;

        // If one is null, but not both, return false.
        if (((object)a == null) || ((object)b == null))
            return false;

        return a.Equals(b);
    }

    public static bool operator !=(UserName a, UserName b)
    {
        return !(a == b);
    }

    public override bool Equals(object obj)
    {
        if ((obj as UserName) == null)
            return false;
        return string.Equals(this, (UserName)obj);
    }

    public override int GetHashCode()
    {
        string stringValue = this.ToString();
        return stringValue != null ? stringValue.GetHashCode() : base.GetHashCode();
    }
}

3 个答案:

答案 0 :(得分：4)

您需要为UserName课程编写自定义Json.NET Converter。在创建自定义转换器之后，您需要告诉Json.NET。在我的一个项目中，我们在Application_Start文件中的Global.asax.cs方法中添加了以下代码行，让Json.NET了解转换器：

// Global Json.Net config settings.
JsonConvert.DefaultSettings = () =>
{
    var settings = new JsonSerializerSettings();
    // replace UserNameConverter with whatever the name is for your converter below
    settings.Converters.Add(new UserNameConverter()); 
    return settings;
};

这是一个应该工作的（未经测试的）的快速和基本实现。几乎可以肯定的是：

public class UserNameConverter : JsonConverter
{

    public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
    {
        var username = (UserName)value;

        writer.WriteStartObject();
        writer.WritePropertyName("UserName");
        serializer.Serialize(writer, username.ToString());
        writer.WriteEndObject();
    }

    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
    {
        // Variables to be set along with sensing variables
        string username = null;
        var gotName = false;

        // Read the properties
        while (reader.Read())
        {
            if (reader.TokenType != JsonToken.PropertyName)
            {
                break;
            }

            var propertyName = (string)reader.Value;
            if (!reader.Read())
            {
                continue;
            }

            // Set the group
            if (propertyName.Equals("UserName", StringComparison.OrdinalIgnoreCase))
            {
                username = serializer.Deserialize<string>(reader);
                gotName = true;
            }
        }

        if (!gotName)
        {
            throw new InvalidDataException("A username must be present.");
        }

        return new UserName(username);
    }

    public override bool CanConvert(Type objectType)
    {
        return objectType == typeof(UserName);
    }
}

答案 1 :(得分：1)

WebAPI可以序列化和序列化类型化结构。你需要做的是遵循打字模式。例如，在Javacsript中，我可以创建像Person

这样的对象 
var person = {
userName: 'bob123',
firstName: 'Bobby',
lastName: 'Doe'
}

然后将其作为我的请求的一部分传递给webAPI

在webAPI中，类型定义为：

[Route("api/membershipinfo/getuserdata")]
[HttpPost]
 public IHttpActionResult DoSomething([FromBody]Person p)
 {
   try
     {
       ...rest of your code here

如果你有.net类型Person并且它与你在javascript请求名称/属性中创建的匹配，它将可用于映射。

关于外壳的注意事项。我遵循camelCasing模式，因此第一个字符始终是小写的。在您的dot net类型中，您不需要执行此操作WebAPI将允许您通过配置对此进行说明。

我是如何完成它的是我的webapi.config中的自定义配置格式化程序，它有助于在序列化期间转换类型

    //source: http://www.asp.net/web-api/overview/formats-and-model-binding/json-and-xml-serialization
    // Replace the default JsonFormatter with our custom one
    ConfigJsonFormatter(config.Formatters);

}
private static void ConfigJsonFormatter(MediaTypeFormatterCollection formatters)
{
    var jsonFormatter = formatters.JsonFormatter;
    var settings = jsonFormatter.SerializerSettings;
    settings.Formatting = Formatting.Indented;
    settings.ContractResolver = new CamelCasePropertyNamesContractResolver();
    settings.TypeNameHandling = TypeNameHandling.Auto;
}

答案 2 :(得分：1)

我建议争取更多的关注点分离。

这里有两个问题：

  1. 处理HTTP请求和响应。
  2. 执行域逻辑。

    3. WebAPI关注处理HTTP请求和响应。它向消费者提供了一份合同，说明他们如何使用其端点和操作。它不应该关心做其他任何事情。

    项目管理

    考虑使用多个项目更清楚地分离问题。

    1. MyNamespace.MyProject - 将保留域逻辑的类库项目。
    2. MyNamespace.MyProject.Service - 仅包含您的网络服务的WebAPI项目。

      3. 在MyNamespace.MyProject上添加对MyNamespace.MyProject.Service的引用。这将有助于您保持清晰的关注点分离。

      不同的课程

      现在，重要的是要了解您将拥有两个具有相同名称的类，但它们是不同的。完全合格，他们的区别变得清晰：

      1. MyNamespace.MyProject.Person - 您的域名表示。
      2. MyNamespace.MyProject.Service.Models.Person - 您的WebAPI人员合同代表。

        3. 您的域图层对象：

        namespace MyNamespace.MyProject
{
    public class Person
    {
        public string FirstName { get; set; }
        public string LastName { get; set; }
        public int Age { get; set; }
        public UserName UserName { get; set; }
    }
}

        您的服务层对象：

        namespace MyNamespace.MyProject.Service.Models
{
    public class Person
    {
        public string FirstName { get; set; }
        public string LastName { get; set; }
        public int Age { get; set; }
        //The service contract expects username to be a string.
        public string UserName { get; set; }
    }
}

        这里的好处是域层表示可以独立于WebAPI合同进行更改。 因此，您的消费者合同不会改变。

        将域逻辑与服务逻辑隔离

        我还建议将对传入Person起作用的任何域逻辑移动到域逻辑类库。 这也允许在其他可能超出WebAPI范围的应用程序和库中重用此逻辑。此外，为了继续将我们的域逻辑与服务逻辑分离，我将实现Repository模式，并创建MyNamespace.MyProject.PersonRepository，定义如何处理域级Person对象的存储库。

        您的控制器现在可能只是这样：

        [Route("api/person")]
[HttpPost]
public void UpdatePerson(Models.Person person)
{
    var mappedPerson = Mapper.Map<Person>(person);
    personRepository.Update(mappedPerson);

    //I'd suggest returning some type of IHttpActionResult here, even if it's just a status code.
}

        Mapper.Map<Person>(person)的魔力来自AutoMapper。您首先应用程序启动时在某个配置类中设置映射。这些映射会告诉AutoMapper如何将MyNamespace.MyProject.Service.Models.Person转换为MyNamespace.MyProject.Person。

        //This gets called once somewhere when the application is starting.
public static void Configure()
{
    //<Source, Destination>
    Mapper.Create<Models.Person, Person>()
        //Additional mappings.
        .ForMember(dest => dest.Username, opt => opt.MapFrom(src => new UserName(src.UserName)))
}

        此外，您可能需要使用Singleton，Service Locator或Inversion of Control（IoC）容器（如Ninject）来获取对personRepository的引用。我强烈建议使用IoC。 Ninject有一个包可以接管为WebAPI创建控制器，注入你已经配置的依赖项。

        我们在这里取得的成就是我们已将所有域逻辑移出MyNamespace.MyProject.Service。 MyNamespace.MyProject现在可以独立测试，甚至可以包含在其他项目中，而不会带来WebAPI依赖项。我们已经明确区分了关注点。

        关于班级命名的注意事项

        相同的类名可能会让某些团队感到困惑。您可以选择实现某种类型的命名约定，以使名称更加清晰，例如附加DTO或{{1} }到服务层中的类。我更喜欢将它们放在不同的命名空间中，并根据需要对它们进行限定。

        参考的第三方图书馆

        1. AutoMapper - 用于减少将服务对象映射到域对象的样板，反之亦然。
        2. Ninject - 用于将依赖项注入控制器（记住也要获取WebAPI或OWIN包）。可以使用任何IoC。或者，也可以使用单例或服务定位器模式，但可能会使测试变得困难。

          3. 这些图书馆都不需要遵循这个答案的想法，但可以让生活更轻松。

相关问题
最新问题