JSON.NET 无需 try/catch 即可解析可选值

Question

所以我一直工作的公司要求我为需要使用 .NET 访问我们的 API 的客户公司制作 C# 库。到目前为止，我有一个工作库，但我一直在解析可选属性时遇到问题。我们在后端使用 mongoDB，而 mongoDB 不会存储未提供的属性，即使它们是在架构中定义的。

例如，我的架构可能如下所示：

{
   name:String,
   id:Number,
   phone:String,
   email:String,
   experience:[]
}

我在哪里制作文档：

{
   name:"joe",
   id:5,
   phone:"222-222-2222",
}

属性email 和experience 在我的文档中不存在，所以我的JSON 看起来与上面显示的完全一样。然而，这些值不是必需的值，但我仍然需要解析它的其余部分。问题是，当我在解析email 或experience 时解析上面所有可能值的代码时，解析器会抛出空引用异常，这是有充分理由的，因为我试图解析的值不存在我引用这些值的方式是这样的：

JObject o=JObject.Parse(json); //parse json to JObject json object
string name=(string)o["name"];
int id=(int)o["id"];
string phone=(string)o["phone"];
string email=(string)o["emain"];
List<string> exp=o["experience"].Select(t => (string)t).ToList();

现在我的代码更加客观，我使用 LINQ 创建了一个名为 Job 的对象和一个对象 Jobs 以存储 JObject 的方式，您可以使用 @ 的方法从中查询某些值987654330@ 使用原始 JSON 字符串初始化的对象。

我能想到的在 JSON 中处理可选属性的唯一方法是尝试/捕获每个值。这看起来很草率，我必须解析的 JSON 总共大约有 40-50 个属性。这似乎会非常缓慢并且代码混乱。我想知道我是否可以实现这是一种更清洁更有效的方式。

Answer 1

除非有充分的理由您不能使用通用的反序列化/序列化方法，否则我建议您更改使用这些方法的方法。一般来说，我认为您在上面所做的条件性、特定于属性的解析类型是非常糟糕的做法。这是一个例子；

public class Job
{
   public string name;
   public string id;
   public string phone;
   public string email;
   public string[] experience; // can also be a List<string> without any problems
}

Job j = JsonConvert.DeserializeObject<Job>(jsonString);

string output = JsonConvert.SerializeObject(j);
//will include "optional" parameters, meaning if there is no phone value it will be an empty string but the property name will still be there.

如果你真的想确认一下，包括一些必需的参数，但不包括其他一些可选参数，我建议将 json 模式与 json.NET 结合使用。您可以执行以下操作；

//schema in flat text file I read with File.ReadAllText(path);
{
    "type":"object",
    "$schema": "http://json-schema.org/draft-03/schema",
    "required":true,
    "properties":{
        "name": { "type":"string", "required":true },
        "id": { "type":"string", "required":true },
                "phone": { "type":"string", "required":false },
                "email": { "type":"string", "required":false },
                "experience": { "type":"array", "required":true, "items": { "string" } }
    }
}

然后在代码中你有类似的东西；

JObject obj = JObject.Parse(json);
JsonSchema jscheme = JsonSchema.Parse(File.ReadAllText(thatSchemaAbove));
IList<string> errors;
obj.IsValid(jscheme, out errors);
if (errors.Count() > 0)
{
     //json didn't match the schema, do something about it!
}

编辑：处理复杂对象；

假设您的 json 是一个对象，其中包含一个名为 jobs 的 Job 对象数组。为此使用以下 C# 类定义；

public class jobsWrapper
{
    public List<Job> jobs;
}

json 中使用的任何构造都有一个 C# 等价物，您只需分解它并确定它是什么。