如何使用Jackson将原始JSON包含在对象中？

当使用Jackson对对象进行反序列化时，我试图在Java对象中包含原始JSON。为了测试此功能，我编写了以下测试：

public static class Pojo {
    public String foo;

    @JsonRawValue
    public String bar;
}

@Test
public void test() throws JsonGenerationException, JsonMappingException, IOException {

    String foo = "one";
    String bar = "{\"A\":false}";

    Pojo pojo = new Pojo();
    pojo.foo = foo;
    pojo.bar = bar;

    String json = "{\"foo\":\"" + foo + "\",\"bar\":" + bar + "}";

    ObjectMapper objectMapper = new ObjectMapper();
    String output = objectMapper.writeValueAsString(pojo);
    System.out.println(output);
    assertEquals(json, output);

    Pojo deserialized = objectMapper.readValue(output, Pojo.class);
    assertEquals(foo, deserialized.foo);
    assertEquals(bar, deserialized.bar);
}

代码输出以下行：

{"foo":"one","bar":{"A":false}}

JSON正是我想要的外观。不幸的是，当尝试将JSON读回对象时，代码会失败并出现异常。这是例外：

org.codehaus.jackson.map.JsonMappingException：无法从[来源：java.io.StringReader@d70d7a; START_OBJECT令牌中反序列化java.lang.String实例。行：1，列：13]（通过参考链：com.tnal.prism.cobalt.gather.testing.Pojo [“ bar”]）

为什么杰克逊在一个方向上只能正常运行，而在另一个方向上却无法运行？似乎它应该能够再次将自己的输出作为输入。我知道我想做的是非正统的（一般建议是为该内部对象创建一个bar名为的属性A），但是我根本不想与此JSON进行交互。我的代码充当该代码的传递对象-我想接受此JSON并再次发送回去而不用碰任何东西，因为当JSON更改时，我不希望我的代码需要修改。

谢谢你的建议。

编辑：使Pojo成为静态类，这将导致另一个错误。

@JsonRawValue仅用于序列化端，因为反向处理起来有些棘手。实际上，添加它是为了允许注入预编码的内容。

我想可能会增加对反向的支持，尽管那会很尴尬：必须先解析内容，然后将其重新写回“原始”格式，该格式可能相同也可能不同（因为字符引用可能会有所不同）。这是一般情况。但这也许对于某些问题子集是有意义的。

但是我认为针对您的特定情况的解决方法是将类型指定为“ java.lang.Object”，因为这应该可以正常工作：对于序列化，将按原样输出String，对于反序列化，将其反序列化为一张地图。实际上，如果这样，您可能想要有一个单独的getter / setter。getter将返回String进行序列化（并且需要@JsonRawValue）；而setter将采用Map或Object。如果可以的话，您可以将其重新编码为字符串。

在@StaxMan回答之后，我做了以下工作，像个魅力：

public class Pojo {
  Object json;

  @JsonRawValue
  public String getJson() {
    // default raw value: null or "[]"
    return json == null ? null : json.toString();
  }

  public void setJson(JsonNode node) {
    this.json = node;
  }
}

并且，为了忠实于最初的问题，以下是工作测试：

public class PojoTest {
  ObjectMapper mapper = new ObjectMapper();

  @Test
  public void test() throws IOException {
    Pojo pojo = new Pojo("{\"foo\":18}");

    String output = mapper.writeValueAsString(pojo);
    assertThat(output).isEqualTo("{\"json\":{\"foo\":18}}");

    Pojo deserialized = mapper.readValue(output, Pojo.class);
    assertThat(deserialized.json.toString()).isEqualTo("{\"foo\":18}");
    // deserialized.json == {"foo":18}
  }
}

我可以用自定义解串器要做到这一点（剪切和粘贴来自这里）

package etc;

import java.io.IOException;

import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.core.TreeNode;
import com.fasterxml.jackson.databind.DeserializationContext;
import com.fasterxml.jackson.databind.JsonDeserializer;

/**
 * Keeps json value as json, does not try to deserialize it
 * @author roytruelove
 *
 */
public class KeepAsJsonDeserialzier extends JsonDeserializer<String> {

    @Override
    public String deserialize(JsonParser jp, DeserializationContext ctxt)
            throws IOException, JsonProcessingException {

        TreeNode tree = jp.getCodec().readTree(jp);
        return tree.toString();
    }
}

@JsonSetter可能会有所帮助。请参阅我的示例（“数据”应该包含未解析的JSON）：

class Purchase
{
    String data;

    @JsonProperty("signature")
    String signature;

    @JsonSetter("data")
    void setData(JsonNode data)
    {
        this.data = data.toString();
    }
}

除了为Roy Truelove提供了一个很好的答案之外，这是如何根据以下情况注入自定义解串器的方法@JsonRawValue：

import com.fasterxml.jackson.databind.Module;

@Component
public class ModuleImpl extends Module {

    @Override
    public void setupModule(SetupContext context) {
        context.addBeanDeserializerModifier(new BeanDeserializerModifierImpl());
    }
}

import java.util.Iterator;

import com.fasterxml.jackson.annotation.JsonRawValue;
import com.fasterxml.jackson.databind.BeanDescription;
import com.fasterxml.jackson.databind.DeserializationConfig;
import com.fasterxml.jackson.databind.deser.BeanDeserializerBuilder;
import com.fasterxml.jackson.databind.deser.BeanDeserializerModifier;
import com.fasterxml.jackson.databind.deser.SettableBeanProperty;

public class BeanDeserializerModifierImpl extends BeanDeserializerModifier {
    @Override
    public BeanDeserializerBuilder updateBuilder(DeserializationConfig config, BeanDescription beanDesc, BeanDeserializerBuilder builder) {
        Iterator<SettableBeanProperty> it = builder.getProperties();
        while (it.hasNext()) {
            SettableBeanProperty p = it.next();
            if (p.getAnnotation(JsonRawValue.class) != null) {
                builder.addOrReplaceProperty(p.withValueDeserializer(KeepAsJsonDeserialzier.INSTANCE), true);
            }
        }
        return builder;
    }
}

这是您的内部类的问题。该Pojo班是一个非静态内部类的测试类的，和杰克逊不能实例化类。因此它可以序列化，但不能反序列化。

像这样重新定义您的班级：

public static class Pojo {
    public String foo;

    @JsonRawValue
    public String bar;
}

注意添加 static

这个简单的解决方案为我工作：

public class MyObject {
    private Object rawJsonValue;

    public Object getRawJsonValue() {
        return rawJsonValue;
    }

    public void setRawJsonValue(Object rawJsonValue) {
        this.rawJsonValue = rawJsonValue;
    }
}

因此，我能够将JSON的原始值存储在rawJsonValue变量中，然后将其（作为对象）与其他字段反序列化为JSON并通过我的REST发送是没有问题的。使用@JsonRawValue并没有帮助我，因为存储的JSON被反序列化为String而不是对象，而这不是我想要的。

这甚至可以在JPA实体中使用：

private String json;

@JsonRawValue
public String getJson() {
    return json;
}

public void setJson(final String json) {
    this.json = json;
}

@JsonProperty(value = "json")
public void setJsonRaw(JsonNode jsonNode) {
    // this leads to non-standard json, see discussion: 
    // setJson(jsonNode.toString());

    StringWriter stringWriter = new StringWriter();
    ObjectMapper objectMapper = new ObjectMapper();
    JsonGenerator generator = 
      new JsonFactory(objectMapper).createGenerator(stringWriter);
    generator.writeTree(n);
    setJson(stringWriter.toString());
}

理想情况下，ObjectMapper甚至JsonFactory都来自上下文，并且配置为正确处理JSON（例如，标准或非标准值，例如“ Infinity”浮点数）。

这是一个完整的工作示例，说明如何使用Jackson模块同时进行@JsonRawValue两种工作（序列化和反序列化）：

public class JsonRawValueDeserializerModule extends SimpleModule {

    public JsonRawValueDeserializerModule() {
        setDeserializerModifier(new JsonRawValueDeserializerModifier());
    }

    private static class JsonRawValueDeserializerModifier extends BeanDeserializerModifier {
        @Override
        public BeanDeserializerBuilder updateBuilder(DeserializationConfig config, BeanDescription beanDesc, BeanDeserializerBuilder builder) {
            builder.getProperties().forEachRemaining(property -> {
                if (property.getAnnotation(JsonRawValue.class) != null) {
                    builder.addOrReplaceProperty(property.withValueDeserializer(JsonRawValueDeserializer.INSTANCE), true);
                }
            });
            return builder;
        }
    }

    private static class JsonRawValueDeserializer extends JsonDeserializer<String> {
        private static final JsonDeserializer<String> INSTANCE = new JsonRawValueDeserializer();

        @Override
        public String deserialize(JsonParser p, DeserializationContext ctxt) throws IOException, JsonProcessingException {
            return p.readValueAsTree().toString();
        }
    }
}

然后，您可以在创建以下模块后注册该模块ObjectMapper：

ObjectMapper objectMapper = new ObjectMapper();
objectMapper.registerModule(new JsonRawValueDeserializerModule());

String json = "{\"foo\":\"one\",\"bar\":{\"A\":false}}";
Pojo deserialized = objectMapper.readValue(json, Pojo.class);

我有完全相同的问题。我在这篇文章中找到了解决方案： 使用Jackson或其替代方法将JSON树解析为普通类

查看最后一个答案。通过为该属性定义一个自定义设置器，该设置器将JsonNode作为参数并调用jsonNode上的toString方法来设置String属性，所有这些都可以解决。

使用对象在两种方法上都可以正常工作...此方法有两次开销，需要两次将原始值反序列化。

ObjectMapper mapper = new ObjectMapper();
RawJsonValue value = new RawJsonValue();
value.setRawValue(new RawHello(){{this.data = "universe...";}});
String json = mapper.writeValueAsString(value);
System.out.println(json);
RawJsonValue result = mapper.readValue(json, RawJsonValue.class);
json = mapper.writeValueAsString(result.getRawValue());
System.out.println(json);
RawHello hello = mapper.readValue(json, RawHello.class);
System.out.println(hello.data);

RawHello.java

public class RawHello {

    public String data;
}

RawJsonValue.java

public class RawJsonValue {

    private Object rawValue;

    public Object getRawValue() {
        return rawValue;
    }

    public void setRawValue(Object value) {
        this.rawValue = value;
    }
}

我遇到了类似的问题，但使用的列表中包含很多JSON itens（List<String>）。

public class Errors {
    private Integer status;
    private List<String> jsons;
}

我使用@JsonRawValue批注管理序列化。但是对于反序列化，我不得不根据Roy的建议创建一个自定义反序列化器。

public class Errors {

    private Integer status;

    @JsonRawValue
    @JsonDeserialize(using = JsonListPassThroughDeserialzier.class)
    private List<String> jsons;

}

在下面，您可以看到我的“列表”解串器。

public class JsonListPassThroughDeserializer extends JsonDeserializer<List<String>> {

    @Override
    public List<String> deserialize(JsonParser jp, DeserializationContext cxt) throws IOException, JsonProcessingException {
        if (jp.getCurrentToken() == JsonToken.START_ARRAY) {
            final List<String> list = new ArrayList<>();
            while (jp.nextToken() != JsonToken.END_ARRAY) {
                list.add(jp.getCodec().readTree(jp).toString());
            }
            return list;
        }
        throw cxt.instantiationException(List.class, "Expected Json list");
    }
}