Jacksonを使用してオブジェクトに未加工のJSONを含めるにはどうすればよいですか?


102

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を取り込んで、何かに触れることなくもう一度送り返したいのです。

アドバイスありがとうございます。

編集:Pojoを静的クラスにしたため、別のエラーが発生していました。

回答:


64

@JsonRawValueは、逆方向を処理するのが少し難しいため、シリアライゼーション側のみを対象としています。実際には、事前にエンコードされたコンテンツを挿入できるようにするために追加されました。

それはかなり厄介ですが、逆のサポートを追加することは可能だと思います:コンテンツを解析してから、「raw」形式に書き直す必要があります。異なる場合があります)。これは一般的なケースです。しかし、おそらくそれは問題の一部のサブセットには意味があります。

しかし、私はあなたの特定のケースの回避策はタイプを「java.lang.Object」として指定することだと思います、これは問題なく動作するはずです:シリアライゼーションの場合、文字列はそのまま出力され、デシリアライゼーションの場合は次のようにデシリアライズされます地図。実際には、個別のゲッター/セッターが必要な場合があります。getterはシリアル化のためにStringを返します(そして@JsonRawValueが必要です)。セッターはマップまたはオブジェクトのいずれかを取ります。それが理にかなっている場合は、文字列に再エンコードできます。


1
これは魅力のように機能します。コードに対する私の応答を参照してください(コメントのフォーマットはawgulです)。
yves amsellem

これには別のユースケースがありました。deser / serで大量の文字列のガベージを生成したくない場合は、文字列をそのままパススルーできるはずです。これを追跡するスレッドを見ましたが、ネイティブサポートは不可能のようです。見ていmarkmail.org/message/...を
シド

@Sidそれとトークン化の両方を効率的に行う方法はありません。未処理のトークンのパススルーをサポートするには、追加の状態保持が必要になるため、「通常の」解析の効率がやや低下します。これは、通常のコードと例外スローの間の最適化に似ています。後者をサポートすると、前者のオーバーヘッドが追加されます。ジャクソンは、未処理の入力を利用できるように保つように設計されていません。それを(エラーメッセージについても)持っておくとよいでしょうが、別のアプローチが必要になります。
StaxMan 2016

55

@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}
  }
}

1
私は試しませんでしたが、うまくいくはずです。1)Object jsonの代わりにJsonNodeノードを作成する2)toString()の代わりにnode.asText()を使用する。2つ目はわかりません。
Vadim Kirilchuk、2015

結局なぜgetJson()帰るのかなStringJsonNodeセッターを介して設定されたものを返しただけの場合、必要に応じてシリアル化されますか?
sorrymissjackson 2016

@VadimKirilchuk node.asText()は、反対の空の値を返しますtoString()
v.ladynev 2018年

36

私はこれをカスタムデシリアライザ(ここからカットアンドペーストし)で行うことができました

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();
    }
}

6
驚くほど簡単です。IMOこれが正式な答えになるはずです。配列、サブオブジェクトなどを含む非常に複雑な構造を試してみました。おそらく回答を編集して、デシリアライズされるStringメンバーに@JsonDeserialize(using = KeepAsJsonDeserialzier.class)による注釈を付ける必要があることを追加します。(そしてクラス名のタイプミスを修正してください;-)
Heri

これはDeserializionで機能します。生のjsonをpojoにシリアライズするのはどうですか?それはどのように達成されますか
xtrakBandit 2015年

4
@xtrakBandit for Serialization、use@JsonRawValue
smartwjw

これは魅力のように機能します。ロイ、@ Heriに感謝します。Heriのコメントとこの投稿の組み合わせは、最高の答えです。
ミハル

シンプルで端正なソリューション。私は@Heriに同意します
mahesh nanayakkara

18

@JsonSetterが役立ちます。私のサンプルを参照してください(「データ」には解析されていないJSONが含まれているはずです):

class Purchase
{
    String data;

    @JsonProperty("signature")
    String signature;

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

3
JsonNode.toString()ドキュメントによると、ノードの開発者が読み取り可能な表現を生成するメソッド。有効なJSONである場合とそうでない場合があります。したがって、これは実際には非常に危険な実装です。
Piotr

@Piotrのjavadocは、「データ
バインドの

4

追加ロイする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;
    }
}

これはジャクソン2.9では機能しません。プロパティ
ベース

3

これは内部クラスの問題です。Pojoクラスは、非static内部クラステストクラスの、とジャクソンはないインスタンス化できるクラスという。したがって、シリアライズはできますが、デシリアライズはできません。

次のようにクラスを再定義します。

public static class Pojo {
    public String foo;

    @JsonRawValue
    public String bar;
}

の追加に注意してください static


ありがとう。これでさらに一歩進みましたが、今は別のエラーが発生しています。元の投稿を新しいエラーで更新します。
bhilstrom、2011年

3

この簡単な解決策は私にとってうまくいきました:

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はオブジェクトではなく文字列としてデシリアライズされ、それが私が望んでいたものではなかったためです。


3

これは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」フロートなどの非標準の値を使用)。


1
JsonNode.toString()ドキュメントによると、Method that will produce developer-readable representation of the node; which may <b>or may not</b> be as valid JSON.これは実際には非常に危険な実装です。
Piotr

こんにちは@Piotr、ヒントをありがとう。もちろん、これはJsonNode.asText()内部的に使用され、Infinityおよびその他の非標準のJSON値を出力します。
Georg、

@Piotrのjavadocは、「データ
バインドの

2

以下は、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);

上記以外に何かしなければならないことはありますか?私は、JsonRawValueDeserializerのデシリアライズメソッドがObjectMapperによって呼び出されないことを発見しました
Michael Coxon

@MichaelCoxonあなたはそれをうまく動かすことができましたか?過去の問題の原因の1つは、org.codehaus.jacksonパッケージの注釈を気付かずに使用したことです。すべてのインポートがからのものであることを確認してくださいcom.fasterxml.jackson
Helder Pereira

1

私はまったく同じ問題を抱えていました。私はこの投稿で解決策を見つけました: Jacksonまたはその代替を使用してJSONツリーをプレーンクラスに解析します

最後の答えをご覧ください。JsonNodeをパラメーターとして受け取り、jsonNodeのtoStringメソッドを呼び出してStringプロパティを設定するプロパティのカスタムセッターを定義することで、すべてが機能します。


1

オブジェクトを使用すると、どちらの方法でも問題なく動作します...この方法では、2回でraw値をデシリアライズするオーバーヘッドが少し発生します。

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;
    }
}

1

同様の問題がありましたが、多くのJSONイテンス(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");
    }
}
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.