Wie kann ich Jackson anweisen, eine Eigenschaft zu ignorieren, für die ich keine Kontrolle über den Quellcode habe?

Kurz gesagt, eine meiner Entitäten hat eine GeometryCollection , die eine Ausnahme auslöst, wenn Sie "getBoundary" aufrufen (das Warum dieses Buches ist ein anderes, sagen wir jetzt, es funktioniert so).

Gibt es eine Möglichkeit, Jackson zu sagen, dass er diesen speziellen Getter nicht einbeziehen soll? Ich weiß, dass ich @JacksonIgnore verwenden kann, wenn ich den Code besitze / kontrolliere. Dies ist jedoch nicht der Fall. Jackson erreicht diesen Punkt durch kontinuierliche Serialisierung der übergeordneten Objekte. Ich habe eine Filteroption in der Jackson-Dokumentation gesehen. Ist das eine plausible Lösung?

Vielen Dank!

Sie können Jackson Mixins verwenden . Beispielsweise:

class YourClass {
  public int ignoreThis() { return 0; }    
}

Mit diesem Mixin

abstract class MixIn {
  @JsonIgnore abstract int ignoreThis(); // we don't need it!  
}

Mit diesem:

objectMapper.getSerializationConfig().addMixInAnnotations(YourClass.class, MixIn.class);

Bearbeiten:

Dank der Kommentare mit Jackson 2.5+ hat sich die API geändert und sollte mit aufgerufen werden objectMapper.addMixIn(Class<?> target, Class<?> mixinSource)

Eine andere Möglichkeit ist, wenn Sie alle unbekannten Eigenschaften ignorieren möchten, den Mapper wie folgt zu konfigurieren:

mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);

Verwenden der Java-Klasse

new ObjectMapper().configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false)

Annotation verwenden

@JsonIgnoreProperties(ignoreUnknown=true)

Annotationsbasierter Ansatz ist besser. Manchmal ist jedoch eine manuelle Bedienung erforderlich. Zu diesem Zweck können Sie ohne ObjectWriter- Methode verwenden .

ObjectMapper mapper   = new ObjectMapper().configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false)
ObjectWriter writer   = mapper.writer().withoutAttribute("property1").withoutAttribute("property2");
String       jsonText = writer.writeValueAsString(sourceObject);

Mix-In-Annotationen funktionieren hier, wie bereits erwähnt, ziemlich gut. Eine andere Möglichkeit, die über die Eigenschaft @JsonIgnore hinausgeht, ist die Verwendung von @JsonIgnoreType, wenn Sie einen Typ haben, der niemals eingeschlossen werden sollte (dh wenn alle Instanzen von GeometryCollection-Eigenschaften ignoriert werden sollten). Sie können es dann entweder direkt hinzufügen (wenn Sie den Typ steuern) oder Mix-In verwenden, wie:

@JsonIgnoreType abstract class MixIn { }
// and then register mix-in, either via SerializationConfig, or by using SimpleModule

Dies kann praktischer sein, wenn Sie viele Klassen haben, die alle einen einzigen 'IgnoredType getContext ()' - Accessor haben (was bei vielen Frameworks der Fall ist).

Ich hatte ein ähnliches Problem, aber es hing mit den bidirektionalen Beziehungen von Hibernate zusammen. Ich wollte eine Seite der Beziehung zeigen und die andere programmgesteuert ignorieren, je nachdem, mit welcher Ansicht ich es zu tun hatte. Wenn du das nicht kannst, bekommst du böse StackOverflowExceptions. Zum Beispiel, wenn ich diese Objekte hätte

public class A{
  Long id;
  String name;
  List<B> children;
}

public class B{
  Long id;
  A parent;
}

Ich würde das parentFeld in B programmgesteuert ignorieren wollen, wenn ich A betrachte, und das childrenFeld in A ignorieren, wenn ich B betrachte.

Ich habe damit angefangen, Mixins zu verwenden, aber das wird sehr schnell schrecklich. Sie haben so viele nutzlose Klassen herumliegen, die nur zum Formatieren von Daten existieren. Am Ende habe ich meinen eigenen Serializer geschrieben, um dies sauberer zu handhaben: https://github.com/monitorjbl/json-view .

Hier können Sie programmgesteuert angeben, welche Felder ignoriert werden sollen:

ObjectMapper mapper = new ObjectMapper();
SimpleModule module = new SimpleModule();
module.addSerializer(JsonView.class, new JsonViewSerializer());
mapper.registerModule(module);

List<A> list = getListOfA();
String json = mapper.writeValueAsString(JsonView.with(list)
    .onClass(B.class, match()
        .exclude("parent")));

Außerdem können Sie mithilfe von Platzhalter-Matchern ganz einfach sehr vereinfachte Ansichten angeben:

String json = mapper.writeValueAsString(JsonView.with(list)
    .onClass(A.class, match()
        .exclude("*")
         .include("id", "name")));

In meinem ursprünglichen Fall bestand die Notwendigkeit für einfache Ansichten wie diese darin, das Nötigste über das Elternteil / Kind zu zeigen, aber es wurde auch für unsere rollenbasierte Sicherheit nützlich. Weniger privilegierte Ansichten von Objekten, die benötigt werden, um weniger Informationen über das Objekt zurückzugeben.

All dies kommt vom Serializer, aber ich habe Spring MVC in meiner App verwendet. Um diese Fälle richtig zu behandeln, habe ich eine Integration geschrieben, die Sie in vorhandene Spring-Controller-Klassen einfügen können:

@Controller
public class JsonController {
  private JsonResult json = JsonResult.instance();
  @Autowired
  private TestObjectService service;

  @RequestMapping(method = RequestMethod.GET, value = "/bean")
  @ResponseBody
  public List<TestObject> getTestObject() {
    List<TestObject> list = service.list();

    return json.use(JsonView.with(list)
        .onClass(TestObject.class, Match.match()
            .exclude("int1")
            .include("ignoredDirect")))
        .returnValue();
  }
}

Beide sind auf Maven Central verfügbar. Ich hoffe, es hilft jemand anderem da draußen. Dies ist ein besonders hässliches Problem mit Jackson, das für meinen Fall keine gute Lösung hatte.

Wenn Sie bestimmte Eigenschaften für eine Klasse IMMER ausschließen möchten, können Sie die folgende setMixInResolverMethode verwenden:

    @JsonIgnoreProperties({"id", "index", "version"})
    abstract class MixIn {
    }

    mapper.setMixInResolver(new ClassIntrospector.MixInResolver(){
        @Override
        public Class<?> findMixInClassFor(Class<?> cls) {
            return MixIn.class;  
        }

        @Override
        public ClassIntrospector.MixInResolver copy() {
            return this;
        }
    });

Ein weiterer guter Punkt ist hier zu verwenden @JsonFilter. Einige Details hier http://wiki.fasterxml.com/JacksonFeatureJsonFilter