如何在 asp.net web api 中获取模型包含文本 json 属性的 json 数据？

Question

我的 postgresql 数据库中有一个名为“application”的数据库表。

id    name     settings
----------------------------------------------------------------
1     x        "{"color":"red", "left":"30px"}"
2     y        "{"menuSize":"4", "menuOrientation":"horizontal"}"

我的设置列的文本类型包含 json 数据作为文本格式。

我在我的 asp.net web api 应用程序中使用这些数据。 wab api 可以将对象转换为 json 数据。

public class AppController : ApiController
{
    App[] apps = new App[] 
    { 
        new App { Id = 1, Name = "x" }, 
        new App { Id = 2, Name = "y" }
    };

    public IEnumerable<App> GetApps()
    {
        return apps;
    }
}

但我的模型包含一个字符串属性，该属性具有 json 格式的数据。

public class AppController : ApiController
{
    App[] apps = new App[] 
    { 
        new App { Id = 1, Name = "x", Settings = "{\"color\":\"red\", \"left\":\"30px\"}" }
    };

    public IEnumerable<App> GetApps()
    {
        return apps;
    }
}

我想得到如下的 json 响应：

[
    {
        id: 1,
        name: "x",
        color: "color",
        left: "30px"
    }
]

所有列都转换为 json 格式。

Answer 1

使用Newtonsoft library解析json，然后添加新属性

public HttpResponseMessage  GetApps()
    JObject jsonObject = JObject.Parse("{\"color\":\"red\", \"left\":\"30px\"}");
    jsonObject.Add("id", 1);
    jsonObject.Add("name", x);

    return new HttpResponseMessage {
         Content = new StringContent(jsonObject.ToString(Formatting.None), Encoding.UTF8, "application/json"),
    };
}

Answer 2

尝试使用以下代码返回 IEnumerable<JObject>，因为您在 settings 中的键是动态的。

public IEnumerable<JObject> GetApps()
    {
        var jsonList = new List<JObject>();
        App[] apps = new App[]
       {
           new App { Id = 1, Name = "x", Settings = "{\"color\":\"red\", \"left\":\"30px\"}" },
           new App { Id = 2, Name = "y", Settings = "{\"menuSize\":\"4\", \"menuOrientation\":\"horizontal\"}" }
       };

        foreach(var app in apps)
        {
            var obj = new JObject();
            obj.Add("id", app.Id);
            obj.Add("name", app.Name);
            JObject settingsJsonObj = JObject.Parse(app.Settings);
            foreach (var property in settingsJsonObj.Properties())
            {
                var name = property.Name;
                obj.Add(name, settingsJsonObj.GetValue(name));                 
            }

            jsonList.Add(obj);
        }
        return jsonList;
    }

结果：

[
{
    "id": 1,
    "name": "x",
    "color": "red",
    "left": "30px"
},
{
    "id": 2,
    "name": "y",
    "menuSize": "4",
    "menuOrientation": "horizontal"
}
]

如果使用asp.net core 3.0，需要添加对Microsoft.AspNetCore.Mvc.NewtonsoftJson的包引用并更新Startup.ConfigureServices调用AddNewtonsoftJson。

services.AddMvc().AddNewtonsoftJson();

更新：

下面是使用Newtonsoft.JsonNewtonsoft.Json在asp.net core 3.0中使用自定义json转换器的demo；

using Newtonsoft.Json;
using Newtonsoft.Json.Linq;
using System;
public class AppJsonConverter : JsonConverter
{
    public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
    {

        writer.WriteStartObject();
        {
            writer.WritePropertyName("Id");
            writer.WriteValue(value.GetType().GetProperty("Id").GetValue(value).ToString());
            writer.WritePropertyName("Name");
            writer.WriteValue(value.GetType().GetProperty("Name").GetValue(value).ToString());

            var settings = value.GetType().GetProperty("Settings").GetValue(value);
            JObject settingsJsonObj = JObject.Parse(settings.ToString());
            foreach (var property in settingsJsonObj.Properties())
            {
                var name = property.Name;
                writer.WritePropertyName(name);
                writer.WriteValue(settingsJsonObj.GetValue(name));                  

            }
        }
        writer.WriteEndObject();
    }


    public override bool CanConvert(Type objectType)
    {
        throw new NotImplementedException();
    }

    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
    {
        throw new NotImplementedException();
    }
}

型号：

[JsonConverter(typeof(AppJsonConverter))]
public class App
{
    public int Id { get; set; }
    public string Name { get; set; }
    public string Settings { get; set; }
}

控制器：

//add `using Newtonsoft.Json;`

public IEnumerable<Object> GetApps()
    {

        App[] apps = new App[]
       {
           new App { Id = 1, Name = "x", Settings = "{\"color\":\"red\", \"left\":\"30px\"}" },
           new App { Id = 2, Name = "y", Settings = "{\"menuSize\":\"4\", \"menuOrientation\":\"horizontal\"}" }
       };

        var jsonServices = JsonConvert.SerializeObject(apps);
        var result = JsonConvert.DeserializeObject<List<Object>>(jsonServices);

        return result;

    }