如何避免 JSONObject Null 检查

Question

我有 JSON 如下所示

{
  "a1": "aaa",
  "b1": 333,
  "c1": {
    "c1": "ccc",
    "d1": "ddd",
    "f1": [
      {"a1": "xyz"},
      {"b1":  "lmn"},
      {"c1":123.00}
    ]
  }
}

我正在将文件读入 String 并创建一个 JSONObject 如下

JSONObject json = new JSONObject(new JSONTokener(str));

JSON 从外部进入我的应用程序，因此内容在时间上可能会有很大不同。 说它可以完全是 null 或者某些元素可以是 null 或者数组大小可以是 0 或 1 或更多等。

当我处理 JSONObject 时，我可以继续使用检查所有元素

json.has and !=null 

这样它就不会抛出任何异常。

我可以有如下代码

if(
      json.has("c") 
   && json.getJSONObject("c")!= null 
   && json.getJSONObject("c").has("f") 
   && json.getJSONObject("c").getJSONArray("f").length() > 1 
   &&json.getJSONObject("c").getJSONArray("f").getJSONObject(1).has("b")
  ){     
      String x = json.getJSONObject("c").getJSONArray("f").getJSONObject(1).getString("b");
   }

这使得代码具有一长串 if 条件。

但是我在想，我可以用 try catch 来附上语句

try {
     String x = json.getJSONObject("c").getJSONArray("f").getJSONObject(1).getString("b");
    }catch(JSONException e) {
        //log and proceed
    }

请建议在这种情况下是否有任何正当理由放置一个较长的 if 条件，而不是仅仅尝试 - 捕获 - 记录并继续。

如果在这种情况下使用 JSONException 有任何“优点”，你也可以分享吗？

Answer 1

选项 0：长 If 语句

我认为这太令人费解了，尤其是当链条变长时。 我会考虑远程类似解决方案的唯一情况是，如果用户需要确切地知道问题出在哪一点，并且有关于如何解决这个问题以及在非常具体的用例中如何发生这种情况的具体指导方针，但是在那个如果你需要大量的 if 语句和 log 语句。

选项 1：Try-Catch

正如您所建议的，Try-catch 确实是可能的，但是您需要确保捕获在 JSON 字段不存在或类型错误时可能发生的所有异常，例如 ClassCastException 和 NullPointerException。 它很短但不是很优雅，正如其他回答者所说可能隐藏其他异常（但您仍然可以记录堆栈跟踪）。

选项2：Java 8 可选

另一种选择是找到一个库，允许您使用 Java 8 可选类型。 例如，建议使用Jackson 。 这更优雅，但也可以成为一个大链。 这也为您的项目增加了一个依赖项。

选项 3：路径表达式

第三种选择是使用路径表达式JsonPath ，您可以将所有语句放入一个表达式中并获得所有结果。 在我看来，这是一个完美的用例，也是迄今为止最好的解决方案。 唯一的缺点是这为您的项目增加了一个依赖项。

Answer 2

请建议在这种情况下是否有任何正当理由放置一个较长的 if 条件，而不是仅仅尝试 - 捕获 - 记录并继续。

这里有几个原因：

• 效率：创建、抛出和捕获异常相对昂贵。 究竟有多昂贵取决于版本，也可能取决于上下文。 在最近的版本中，JIT 编译器可以 (AFAIK) 将一些序列优化为条件分支。 但是，如果您要记录异常，那么 JVM 将不得不创建异常 object 并填充堆栈跟踪，这是最昂贵的部分。

• 如果您将NullPointerException记录为：

   json.getJSONObject("c").getJSONArray("f").getJSONObject(1).getString("b")

  您可能无法分辨缺少哪些组件或 null。 堆栈跟踪中的行号不足以区分这些情况。 （使用JSONException异常消息将为您提供更多线索。）

• 您也无法区分json是null的情况，这可能是另一种问题； 即一个错误。 如果您将其视为数据错误，则很难找到和修复代码错误。

• 如果您捕获所有异常（如另一个答案所建议的那样），您可能会隐藏更多类别的错误。 馊主意。

---

如果在这种情况下使用 JSONException 有任何“优点”，你也可以分享吗？

唯一真正的“优点”是它可能需要更少的代码，特别是如果你可以尝试...捕获很多这样的代码。

最重要的是，您需要自己权衡一下。 一个因素是您获得不符合您的代码预期的 JSON 的可能性有多大。 这将部分取决于生产 JSON 的产品。

Answer 3

感谢上面的回复，下面是问题的解决方法。

JSONPath最适合我提到的场景。 感谢@Konrad。

首先创建一个 com.jayway.jsonpath.Configuration 类型的配置object

Configuration conf = Configuration.builder().options(Option.SUPPRESS_EXCEPTIONS).mappingProvider(new JsonOrgMappingProvider()).jsonProvider(new JsonOrgJsonProvider()).build();

• Option.SUPPRESS_EXCEPTIONS - 这将有助于在缺少元素的情况下抑制异常
• mappingProvider(new JsonOrgMappingProvider()).jsonProvider(new JsonOrgJsonProvider() - 这使用了正确的提供程序，因此当我们解析 json 时，我们不需要将 JSONObject 转换为 String 从而提供最佳性能。

DocumentContext docContext = JsonPath.using(conf).parse(json);

如果我们使用默认提供程序，那么我们需要按如下方式解析 JSONObject

DocumentContext docContext = JsonPath.using(conf).parse(json.toString());

然后阅读我使用的元素

docContext.read("$.a.b.c.d.values[0].e.f")

性能现在也是最佳的。 花费更多时间和 memory 的原因是因为

• 我在一个循环中同时阅读和解析。 后来我将解析移出循环。
• 我正在使用默认提供程序并且正在执行 json.toString()