Как сериализовать Связанный объект по-разному, используя Jackson и аннотации?
учитывая следующую иерархию классов, я хотел бы сериализовать Foo по-разному в зависимости от контекста, который он используется в моей иерархии классов.
public class Foo {
public String bar;
public String biz;
}
public class FooContainer {
public Foo fooA;
public Foo fooB;
}
Я хотел бы, чтобы атрибут biz не появлялся в fooB при сериализации FooContainer. Таким образом, результат будет выглядеть примерно следующим образом.
{
"fooA": {"bar": "asdf", "biz": "fdsa"},
"fooB": {"bar": "qwer"}
}
Я собирался использовать что-то JsonView, но это должно быть применено на слое mapper для всех экземпляров класса, и это контекст зависимый.
В списке рассылки пользователей Jackson Tatu дал самое простое решение (работает в 2.0), которое я, вероятно, буду использовать сейчас. Присуждение награды jlabedo, потому что ответ-потрясающий пример того, как расширить Джексона, используя пользовательские аннотации.
public class FooContainer {
public Foo fooA;
@JsonIgnoreProperties({ "biz" })
public Foo fooB;
}
3 ответов
вы можете использовать комбинацию пользовательского сериализатора с настраиваемым фильтром свойств с помощью JsonViews. Вот некоторый код, работающий с Jackson 2.0
определите пользовательскую аннотацию:
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface FilterUsingView {
Class<?>[] value();
}
определить, какой вид:
// Define your views here
public static class Views {
public class Public {};
public class Internal extends Public{};
}
тогда вы можете написать свои сущности так. Обратите внимание, что вы можете определить свою собственную аннотацию вместо использования @JsonView
:
public class Foo {
@JsonView(Views.Public.class)
public String bar;
@JsonView(Views.Internal.class)
public String biz;
}
public class FooContainer {
public Foo fooA;
@FilterUsingView(Views.Public.class)
public Foo fooB;
}
тогда вот где начинается код :) Сначала ваш обычай фильтр:
public static class CustomFilter extends SimpleBeanPropertyFilter {
private Class<?>[] _nextViews;
public void setNextViews(Class<?>[] clazz){
_nextViews = clazz;
}
@Override
public void serializeAsField(Object bean, JsonGenerator jgen,
SerializerProvider prov, BeanPropertyWriter writer)
throws Exception {
Class<?>[] propViews = writer.getViews();
if(propViews != null && _nextViews != null){
for(Class<?> propView : propViews){
System.out.println(propView.getName());
for(Class<?> currentView : _nextViews){
if(!propView.isAssignableFrom(currentView)){
// Do the filtering!
return;
}
}
}
}
// The property is not filtered
writer.serializeAsField(bean, jgen, prov);
}
}
затем пользовательского AnnotationIntrospector
это сделает две вещи:
- включить пользовательский фильтр для любого компонента... Если другой фильтр не определен в вашем классе (поэтому вы не можете использовать оба из них, если видите, что я имею в виду)
- включите CustomSerializer, если он нашел
@FilterUsingView
Примечание.
здесь код
public class CustomAnnotationIntrospector extends AnnotationIntrospector {
@Override
public Version version() {
return DatabindVersion.instance.version();
}
@Override
public Object findFilterId(AnnotatedClass ac) {
// CustomFilter is used for EVERY Bean, unless another filter is defined
Object id = super.findFilterId(ac);
if (id == null) {
id = "CustomFilter";
}
return id;
}
@Override
public Object findSerializer(Annotated am) {
FilterUsingView annotation = am.getAnnotation(FilterUsingView.class);
if(annotation == null){
return null;
}
return new CustomSerializer(annotation.value());
}
}
вот ваш пользовательский сериализатор. Единственное, что он делает, это проходит мимо вашего значение аннотации для вашего настраиваемого фильтра, а затем позволяет сериализатору по умолчанию выполнять эту работу.
public class CustomSerializer extends JsonSerializer<Object> {
private Class<?>[] _activeViews;
public CustomSerializer(Class<?>[] view){
_activeViews = view;
}
@Override
public void serialize(Object value, JsonGenerator jgen,
SerializerProvider provider) throws IOException,
JsonProcessingException {
BeanPropertyFilter filter = provider.getConfig().getFilterProvider().findFilter("CustomFilter");
if(filter instanceof CustomFilter){
CustomFilter customFilter = (CustomFilter) filter;
// Tell the filter that we will filter our next property
customFilter.setNextViews(_activeViews);
provider.defaultSerializeValue(value, jgen);
// Property has been filtered and written, do not filter anymore
customFilter.setNextViews(null);
}else{
// You did not define a CustomFilter ? Well this serializer is useless...
provider.defaultSerializeValue(value, jgen);
}
}
}
наконец-то ! Давайте сложим все это вместе:
public class CustomModule extends SimpleModule {
public CustomModule() {
super("custom-module", new Version(0, 1, 0, "", "", ""));
}
@Override
public void setupModule(SetupContext context) {
super.setupModule(context);
AnnotationIntrospector ai = new CustomAnnotationIntrospector();
context.appendAnnotationIntrospector(ai);
}
}
@Test
public void customField() throws Exception {
FooContainer object = new FooContainer();
object.fooA = new Foo();
object.fooA.bar = "asdf";
object.fooA.biz = "fdsa";
object.fooB = new Foo();
object.fooB.bar = "qwer";
object.fooB.biz = "test";
ObjectMapper mapper = new ObjectMapper();
mapper.registerModule(new CustomModule());
FilterProvider fp = new SimpleFilterProvider().addFilter("CustomFilter", new CustomFilter());
StringWriter writer = new StringWriter();
mapper.writer(fp).writeValue(writer, object);
String expected = "{\"fooA\":{\"bar\":\"asdf\",\"biz\":\"fdsa\"},\"fooB\":{\"bar\":\"qwer\"}}";
Assert.assertEquals(expected, writer.toString());
}
import static org.junit.Assert.*;
import java.io.IOException;
import java.io.StringWriter;
import java.lang.reflect.Type;
import org.codehaus.jackson.JsonGenerationException;
import org.codehaus.jackson.JsonGenerator;
import org.codehaus.jackson.JsonNode;
import org.codehaus.jackson.map.JsonMappingException;
import org.codehaus.jackson.map.ObjectMapper;
import org.codehaus.jackson.map.SerializerProvider;
import org.codehaus.jackson.map.annotate.JsonSerialize;
import org.codehaus.jackson.map.ser.SerializerBase;
import org.junit.Test;
class Foo {
public String bar;
public String biz;
}
class FooContainer {
public Foo fooA;
@JsonSerialize(using = FooCustomSerializer.class)
public Foo fooB;
}
class FooCustomSerializer extends SerializerBase<Foo> {
public FooCustomSerializer() {
super(Foo.class);
}
@Override
public void serialize(Foo foo, JsonGenerator generator, SerializerProvider provider) throws IOException, JsonGenerationException {
generator.writeStartObject();
generator.writeObjectField("bar", foo.bar);
generator.writeEndObject();
}
@Override
public JsonNode getSchema(SerializerProvider arg0, Type arg1) throws JsonMappingException {
return null;
}
}
public class JacksonTest {
@Test
public void customField() throws Exception {
FooContainer object = new FooContainer();
object.fooA = new Foo();
object.fooA.bar = "asdf";
object.fooA.biz = "fdsa";
object.fooB = new Foo();
object.fooB.bar = "qwer";
object.fooB.biz = "test";
ObjectMapper mapper = new ObjectMapper();
StringWriter writer = new StringWriter();
mapper.writeValue(writer, object);
String expected = "{\"fooA\":{\"bar\":\"asdf\",\"biz\":\"fdsa\"},\"fooB\":{\"bar\":\"qwer\"}}";
assertEquals(expected, writer.toString());
}
}
использование @JsonSerialize(использование = FooCustomSerializer.класс) на fooB публичных Фу; поле.
http://jackson.codehaus.org/1.9.9/javadoc/org/codehaus/jackson/map/annotate/JsonSerialize.html
Я бы использовал код google gson
документация здесь https://code.google.com/p/google-gson/
Зависимость Maven:
<dependency>
<groupId>com.google.code.gson</groupId>
<artifactId>gson</artifactId>
<version>2.2.1</version>
</dependency>
аннотации таковы:
Чтобы предоставить пользователю поля @Expose
аннотации
Чтобы создать специальное имя для поля в анализируемом JSON-пользователе @SerializedName("fieldNameInJSON")
аннотации
Поэтому ваши занятия будут выглядеть так:
public class Foo {
@SerializedName("bar")
@Expose
public String bar;
@SerializedName("biz")
@Expose
public String biz;
}
public class FooContainer {
@SerializedName("fooA")
@Expose
public Foo fooA;
@SerializedName("fooB")
@Expose
public Foo fooB;
}
для сериализации в JSON вы будете использовать код, который выглядит так:
public String convertToJSON(FooContainer fc) {
if (fc != null) {
GsonBuilder gson = new GsonBuilder();
return gson.excludeFieldsWithoutExposeAnnotation().create().toJson(fc);
}
return "";
}
это будет выглядеть одинаково для списков, например:
public String convertToJSON(List<FooContainer> fcs) {
if (fcs != null) {
GsonBuilder gson = new GsonBuilder();
return gson.excludeFieldsWithoutExposeAnnotation().create().toJson(fcs);
}
return "";
}