问题 JSR-353如何使用javax.json.JsonObjectBuilder添加空值

由于javax.json文档建议创建JsonObject的方法是使用提供的构建器，如：

JsonBuilderFactory factory = Json.createBuilderFactory(config);
 JsonObject value = factory.createObjectBuilder()
     .add("firstName", "John")
     .add("lastName", "Smith")
     .add("age", 25)
     .add("address", factory.createObjectBuilder()
         .add("streetAddress", "21 2nd Street")
         .add("city", "New York")
         .add("state", "NY")
         .add("postalCode", "10021"))
     .add("phoneNumber", factory.createArrayBuilder()
         .add(factory.createObjectBuilder()
             .add("type", "home")
             .add("number", "212 555-1234"))
         .add(factory.createObjectBuilder()
             .add("type", "fax")
             .add("number", "646 555-4567")))
     .build();

此示例添加了给定键的值。在现实生活中，这些值可能来自某些（pojo）域对象，如：

JsonBuilderFactory factory = Json.createBuilderFactory(config);
 JsonObject value = factory.createObjectBuilder()
     .add("firstname", customer.getFirstame())
     .add("lastname", customer.getLastame())
     .add("age", customer.getAge())
     ....

如果key或value为null，则JsonOBjectBuilder抛出NPE。如果客户没有注册年龄，则上述代码将抛出NPE。

因此，基本上对于我添加的每个字段，我必须检查值是否为null并添加实际值，否则不添加字段或为密钥添加JsonValue.NULL。这导致很多（不希望的）样板...

在我的情况下，我最终得到了自定义JsonUtils类，包括各种静态方法，如：

public static void add(JsonObjectBuilder builder, String name, Long value) {
    if (value == null) {
        builder.add(name,  JsonValue.NULL);
    }
    else {
        builder.add(name, value);
    }
}

public static void add(JsonObjectBuilder builder, String name, String value) {
    if (value == null) {
        builder.add(name,  JsonValue.NULL);
    }
    else {
        builder.add(name, value);
    }
}

然后打电话：

builder = Json.createObjectBuilder();
JsonUtils.add(builder, "id", customer.getId());
JsonUtils.add(builder, "name", customer.getName());
JsonUtils.add(builder, "gender", customer.getGender());
builder.build()

但是如果感觉不对劲的话。为什么javax.json没有提供更简单的方法来添加空值（没有if else样板）或者我错过了什么？

我对JSR-353 api的主要批评是，尽管它看起来非常好看流利 api（参见apidoc的顶级示例）但实际上并非如此。

6906

2018-03-12 21:11

起源

实际上有几十种比JSR-353更好的选择;所以也许看看杰克逊jr（github.com/FasterXML/jackson-jr）？它拥有真正流畅的API（“作曲家”），与JSON-P不同，它具有更多“sorta-kinda-almost”版本。 - StaxMan

答案:

可能很难得到你的 JsonObjectBuilder 从工厂实施，但你可以使它更简单。

创建一个 JsonObjectBuilder 检查的装饰器类 null：

public class NullAwareJsonObjectBuilder implements JsonObjectBuilder {
    // Use the Factory Pattern to create an instance.
    public static JsonObjectBuilder wrap(JsonObjectBuilder builder) {
      if (builder == null) {
        throw new IllegalArgumentException("Can't wrap nothing.");
      }
      return new NullAwareJsonObjectBuilder(builder);
    }

    // Decorated object per Decorator Pattern.
    private final JsonObjectBuilder builder;

    private NullAwareJsonObjectBuilder(JsonObjectBuilder builder) {
      this.builder = builder;
    }

    public JsonObjectBuilder add(String name, JsonValue value) {
      builder.add(name, (value == null) ? JsonValue.NULL : value);
    }

    // Implement all other JsonObjectBuilder methods.
    ..
}

以及如何使用它：

JsonObjectBuilder builder = NullAwareJsonObjectBuilder.wrap(
        factory.createObjectBuilder());
builder.add("firstname", customer.getFirstame())
    .add(...

2018-03-13 08:38

有趣的想法。我想知道是否有可能进一步推动这个并让工厂返回一个NullAwareJsonObjectBuilder本身？ - Marcel Overdijk

我曾经看过使用ServiceLoader提供我自己的JsonProviderImpl，但是扩展glassfish类并不是一个真正的选择。几乎所有方便的领域和方法都是私人的，所以最终会复制一切。 - Marcel Overdijk

刚刚实施此解决方案......效果很好。我在实施方法的过程中学到了一些小问题。首先，您需要一个返回类型（在大多数情况下返回此值;为build（）情况返回builder.build（））。其次，其中带有JsonValue.NULL的三元运算符不适用于其他方法签名。我最终得到了一个简单的条件if（arg1 == null）{builder.addNull（arg0）; } else {builder.add（arg0，arg1）; } - Daniel Widdis

我发现这样的事情令人难以置信，这样的事情不是默认实现的一部分。这有什么好的理由吗？ - Itai

另一种可能的解决方案是使用简单和瘦的帮助器来包装值 JsonValue 对象或回归 JsonValue.NULL 如果value为null。

这是一个例子：

public final class SafeJson {
    private static final String KEY = "1";

    //private ctor with exception throwing

    public static JsonValue nvl(final String ref) {
        if (ref == null) {
            return JsonValue.NULL;
        }
        return Json.createObjectBuilder().add(KEY, ref).build().get(KEY);
    }

    public static JsonValue nvl(final Integer ref) {
        if (ref == null) {
            return JsonValue.NULL;
        }
        return Json.createObjectBuilder().add(KEY, ref).build().get(KEY);
    }

    public static JsonValue nvl(final java.sql.Date ref) {
        if (ref == null) {
            return JsonValue.NULL;
        }
        return Json.createObjectBuilder().add(KEY, ref.getTime()).build().get(KEY);
    }
}

用法很简单：

Json.createObjectBuilder().add("id", this.someId)
    .add("zipCode", SafeJson.nvl(this.someNullableInt))
    .add("phone", SafeJson.nvl(this.someNullableString))
    .add("date", SafeJson.nvl(this.someNullableDate))
    .build();

构造像 Json.createObjectBuilder().add(KEY, ref).build().get(KEY); 看起来有点奇怪，但它是唯一可以将价值包装进去的方式 JsonValue 到目前为止我找到了。

事实上，在JavaEE8中，您可以将其替换为：

Json.createValue()

或基础：

JsonProvider.provider().createValue()

呼叫。

2017-10-11 18:51

问题 JSR-353如何使用javax.json.JsonObjectBuilder添加空值

答案:

热门问题