使用杰克逊数据绑定跳过嵌套字段？

Question

我必须如何使用 Jackson 将以下 json sn-p 绑定（双向）到下面的 Java 对象？

我希望 Json newsletter 节点的键/值对最终出现在 newsletter 字段的 Map 中。 绑定 this 的 Jackson 配置（注释和其他）必须是什么？ 抱歉，我不知道怎么做 :(（使用最新版本的 Jackson）。

下面的 Json 格式是固定的，我是从第三方 rest 服务收到的（我无法更改）。我可以更改 java 代码，但更喜欢下面的设置。

JSON：

{
    "newsletter": {
        "key1": "value1",
        "key2": "value2",
        "key3": "value3"
    }
}

Java 对象：

class Preferences {
    private NewsLetter newsLetter;
    // getter/setter for field newsLetter.
}

class NewsLettter {
    private Map<String, String> properties;
    // getter/setter for field properties.
}

Answer 1

您可以简单地使用@JsonAnySetter 进行反序列化

可用于定义非静态、双参数方法（属性的第一个参数名称，要设置的第二个值）的标记注释，用作从 JSON 中找到的所有其他无法识别的属性的“后备”处理程序内容。

还有@JsonAnyGetter 用于序列化。

可用于将非静态、无参数方法或成员字段定义为与JsonAnySetter 方法相反的标记注释；基本上像 getter 一样使用，但是返回的 Map 的内容（类型必须是 Map）被序列化，就好像它们是包含带有此注释的方法/字段的 bean 的实际属性

public class Newsletter {

    private final Map<String, String> properties = new HashMap<>();

    @JsonAnySetter
    public void addProperty(String name, String value) {
        properties.put(name, value);
    }

    @JsonAnyGetter
    public Map<String, String> getProperties() {
        return properties;
    }
}

这应该适用于您的用例。

测试

public class Main {

    public static void main(String[] args) throws Exception {
        String json
                = "{\n"
                + "    \"newsletter\": {\n"
                + "        \"key1\": \"value1\",\n"
                + "        \"key2\": \"value2\",\n"
                + "        \"key3\": \"value3\"\n"
                + "    }\n"
                + "}";

        ObjectMapper mapper = new ObjectMapper();
        Preferences prefs = mapper.readValue(json, Preferences.class);
        Map<String, String> properties = prefs.getNewsletter().getProperties();
        for (Map.Entry<String, String> prop: properties.entrySet()) {
            System.out.println(prop.getKey() + ":" + prop.getValue());
        }
    }
}

另请参阅：

• Jackson tips: using @JsonAnyGetter/@JsonAnySetter to create "dyna beans"

Answer 2

如果你能得到一个合适的 JSON，像这样：

{
    "newsletter": {
        "key1": "value1",
        "key2": "value2",
        "key3": "value3"
    }
}

（注意, 是分隔符而不是;）

那么您可以使用以下类来保存您的 JSON 数据：

class Preferences {
    @JsonProperty("newsletter")
    private Map<String, String> newsLetter;

    @Override
    public String toString() {
        return "Preferences{" + "newsLetter=" + newsLetter + '}';
    }
}

在这里，您不再使用 NewsLetter 类，因为您需要一个嵌套键，就像 Roman C 在他的回答中所说的那样。只需将Map 字段直接添加到您的Preferences 类中即可。

您可以像这样读取您的 JSON：

public static void main(String[] args) throws Exception {
    ObjectMapper om = new ObjectMapper();
    System.out.println(om.readValue(new File("example.json"), Preferences.class));
}

它会打印：

偏好{newsLetter={key1=value1, key2=value2, key3=value3}}

Answer 3

以下是 JSON 到 Java 转换的工作原理

第一步是创建保存 JSON 数据的 Java 类。你已经有了一个。看一下json。您创建一个 Preferences 对象来保存 整个json。 json 包含一个 newsletter 元素。你 在Preferences 对象中创建Newsletter 类型的Java 对象。 创建org.codehaus.jackson.map.ObjectMapper 类的实例。这是课 将 JSON 映射到 Java 对象。

 ObjectMapper mapper = new ObjectMapper();

然后使用ObjectMapper的readValue方法读取。此方法有多个版本，您可以使用采用 String。但是，有些方法可以从 URL、File、InputStream、String 或 ByteArray 读取。

ObjectMapper 缓存序列化器和反序列化器，因此最好将ObjectMapper 实例用于多个 转化 如果您有 String，则将其传递给 Jackson 以将其转换为 Java 对象。

String str = "
    { \"newsletter\":
      {
        \"properties\": {
         \"key1\" : \"value1\",
         \"key2\" : \"value2\",
         \"key3\" : \"value3\"
      }
     }
   }";

//read json
Preferences preferences = mapper.readValue(str, Preferences.class);
//write json
mapper.writeValue(str, preferences);

您可以使用将 json 转义为 java 字符串的工具：http://www.freeformatter.com/java-dotnet-escape.html

此工具产生以下结果

{ \"newsletter\":\r\n          {\r\n            \"properties\": {\r\n             \"key1\" : \"value1\",\r\n             \"key2\" : \"value2\",\r\n             \"key3\" : \"value3\"\r\n          }\r\n         }\r\n        }

Answer 4

我想我成功了。 我用

• @JsonValue 创建时事通讯的 JSON 部分。
• @JsonCreator 使用地图创建 NewsLetter 实例 包含键/值对。
• @JsonTypeInfo 指示使用哪个实现来创建 NewsLetter 实例。

使用上面的 json sn-p ，测试运行良好，双向。 在代码中（Preferences 类与原始问题中列出的相同）：

@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, include = JsonTypeInfo.As.EXISTING_PROPERTY, defaultImpl = NewsLetterPreferencesDefault.class)
public interface NewsLetterPreferences  {
}

public final class NewsLetterPreferencesDefault {
    private Map<String, String> properties;

    @JsonCreator
    public NewsLetterPreferencesDefault(final Map<String, String> properties) {
        this.properties = properties.
    }

    @JsonValue
    public Map<String, String> getAllProperties() {
        return this.properties;
    }
}

有办法吗？我以前从未使用过@JsonTypeInfo，所以我希望它是正确的。我会用谷歌搜索更多的例子。感谢所有反馈。