从类中获取要在查询字符串中使用的 JSON 属性名称列表

Question

如果我有一个 C# 模型类，JSON.net 使用它来绑定序列化 JSON 字符串中的数据，有没有办法可以从该类创建查询字符串以发出初始请求？

模型类示例：

public class model
{
   [JsonProperty(PropertyName = "id")]
   public long ID { get; set; }
   [JsonProperty(PropertyName = "some_string")]
   public string SomeString {get; set;} 
}

查询字符串示例：

baseUrl + uri + "&fields=id,some_string" + token

所以我想要做的本质是从模型对象中收集“id”和“some_string”，这样我就可以动态地创建一个“&fields”参数。 谢谢！

Answer 1

@Leigh Shepperson 有正确的想法； 但是，您可以使用 LINQ 以更少的代码来完成。 我会创建一个这样的辅助方法：

using System.Linq;
using System.Reflection;
using Newtonsoft.Json;
...

public static string GetFields(Type modelType)
{
    return string.Join(",",
        modelType.GetProperties()
                 .Select(p => p.GetCustomAttribute<JsonPropertyAttribute>())
                 .Select(jp => jp.PropertyName));
}

你可以这样使用它：

var fields = "&fields=" + GetFields(typeof(model));

编辑

如果您在 .Net Framework 的 3.5 版本下运行，因此您没有可用的通用GetCustomAttribute<T>方法，则可以使用非通用GetCustomAttributes()方法执行相同的操作，使用它与SelectMany和Cast<T> ：

    return string.Join(",",
        modelType.GetProperties()
                 .SelectMany(p => p.GetCustomAttributes(typeof(JsonPropertyAttribute))
                                   .Cast<JsonPropertyAttribute>())
                 .Select(jp => jp.PropertyName)
                 .ToArray());

Answer 2

您可以使用反射来做到这一点。 这是一般的想法：

using Newtonsoft.Json;
using Newtonsoft.Json.Serialization;
using System.Reflection;

namespace ConsoleApplication8
{
    public class model
    {
        [JsonProperty(PropertyName = "id")]
        public long ID { get; set; }

        [JsonProperty(PropertyName = "some_string")]
        public string SomeString { get; set; }
    }

    internal class Program
    {
        private static void Main(string[] args)
        {
            var model = new model();

            var result = string.Empty;

            PropertyInfo[] props = typeof(model).GetProperties();
            foreach (PropertyInfo prop in props)
            {
                foreach (object attr in prop.GetCustomAttributes(true))
                {
                    result += (attr as JsonPropertyAttribute).PropertyName;
                }
            }
        }
    }
}

Answer 3

如果模型只是部分标注了[JsonProperty(PropertyName = "XXX")]属性，或者标注了数据契约属性，或者忽略了属性，可以使用 Json.NET 自带的 契约解析器获取序列化列表属性名称。 首先介绍如下扩展方法：

public static class JsonExtensions
{
    public static string [] PropertyNames(this IContractResolver resolver, Type type)
    {
        if (resolver == null || type == null)
            throw new ArgumentNullException();
        var contract = resolver.ResolveContract(type) as JsonObjectContract;
        if (contract == null)
            return new string[0];
        return contract.Properties.Where(p => !p.Ignored).Select(p => p.PropertyName).ToArray();
    }
}

然后做：

// Allocate the relevant contract resolver. 
// Options are CamelCasePropertyNamesContractResolver() or DefaultContractResolver().
IContractResolver resolver = new DefaultContractResolver(); 

// Get properties
var propertyNames = resolver.PropertyNames(typeof(model));
var fields = "&fields=" + String.Join(",", propertyNames);

对于resolver如果您对属性名称进行驼峰式大小写（ASP.NET Core Web API默认情况下CamelCasePropertyNamesContractResolver ，请使用CamelCasePropertyNamesContractResolver ； 否则使用DefaultContractResolver 。

样品小提琴。

Answer 4

解决空异常问题的@Brian Rogers 解决方案的一个小变体：

IEnumerable<string> props = typeof(T).GetProperties()
                                     .Select(p => p.GetCustomAttribute<JsonPropertyAttribute>())
                                     .Where(jp => jp != null)
                                     .Select(jp => jp.PropertyName);

string propsList = string.Join(',', props);