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

json java jakarta-ee glassfish jsr-353

2022-09-02 22:04:43

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())
     ....

JsonOBjectBuilder 会在键或值为 null 的情况下引发 NPE。如果客户没有注册年龄，则上述代码将抛出NPE。

因此，基本上对于我添加的每个字段，我必须检查该值是否为空并添加实际值，否则不要添加该字段或为键添加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没有提供更简单的方法来添加空值（如果没有其他样板），或者我错过了什么？

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

答案 1

从工厂获取实现可能很困难，但您可以使其更简单。JsonObjectBuilder

创建一个用于检查以下各项的修饰器类：JsonObjectBuildernull

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(...

答案 2

另一种可能的解决方案是使用简单而精简的帮助程序将值包装到对象中，或者如果值为 null，则返回。JsonValueJsonValue.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()

叫。