Question

根据official documenation添加自定义Jackson序列化程序后，我发现了一种略有不同的json输出格式。

此示例基于spring-restbucks的分支。

从org.springsource.restbucks.WebConfiguration扩展RepositoryRestMvcConfiguration并覆盖configureJacksonObjectMapper：

@Override
protected void configureJacksonObjectMapper(ObjectMapper objectMapper) {
    final SimpleSerializers serializers = new SimpleSerializers();
    serializers.addSerializer(Order.class, new OrderSerializer());
    objectMapper.registerModule(new SimpleModule("CustomSerializerModule"){
        @Override public void setupModule(SetupContext context) {
            context.addSerializers(serializers);
        }
    });
}

创建课程org.springsource.restbucks.order.OrderSerializer。为简洁起见，只需将属性paid写为JSON。

public class OrderSerializer extends JsonSerializer<Order> {
    @Override
    public void serialize(Order value, JsonGenerator jgen, SerializerProvider provider) throws IOException {
        jgen.writeStartObject();
        jgen.writeBooleanField("paid", value.isPaid());
        jgen.writeEndObject();
    }
}

在添加OrderSerializer之前，http://localhost:8080/orders/1的json响应如下：

{
  "location": "TAKE_AWAY",
  "status": "PAYMENT_EXPECTED",
  "orderedDate": "2014-03-24T15:05:09.988+01:00",
  "items": [
    {
      "name": "Java Chip",
      "quantity": 1,
      "milk": "SEMI",
      "size": "LARGE",
      "price": {
        "currency": "EUR",
        "value": 4.2
      }
    }
  ],
  "_links": {
    ...
  }
}

添加OrderSerializer后，http://localhost:8080/orders/1的json响应类似于

{
  "content": {
    "paid": false
  },
  "_links": {
    ...
  }
}

主要观点是付费属性被包装到另一个对象内容中，该内容是org.springframework.hateoas.Resource的属性。我期待没有这个属性的回复：

{
  "paid": false,  
  "_links": {
    ...
  }
}

我查看了杰克逊代码，发现UnwrappingBeanSerializer可能是我正在寻找的解决方案。在看了如何初始化UnwrappingBeanSerializer之后，我认为这个序列化程序并不是为了自定义使用而进行子类化。

我想知道使用自定义序列化程序时这种偏离的json格式是正常行为还是Spring Data Rest中的错误。任何形式的帮助都表示赞赏。

Answer 1

这不是Spring Data Rest的错误，它实际上是Jackson Serializer的正常行为。每当您使用@JsonUnwrapped Annotation（作为资源内容字段）和自定义Serializer一起使用时，Jackson Serializer将显式写入字段名称（在本例中为内容）。有关更多详细信息，请查看UnwrappingBeanPropertyWriter。无论如何，你使用UnwrappingBeanSerializer一直在正确的轨道上，但设置与通常的Serializer注册略有不同。以下示例应解决您的问题：

@Override
protected void configureJacksonObjectMapper(ObjectMapper objectMapper) {
    mapper.registerModule(new Module() {
        @Override
        public String getModuleName() {
            return "my.module";
        }

        @Override
        public Version version() {
            return Version.unknownVersion();
        }

        @Override
        public void setupModule(SetupContext context) {

            context.addBeanSerializerModifier(new BeanSerializerModifier() {
                @Override
                public JsonSerializer<?> modifySerializer(SerializationConfig config, BeanDescription beanDesc, JsonSerializer<?> serializer) {
                    if(beanDesc.getBeanClass().equals(Order.class)) {
                        return new UnwrappingOrderSerializer((BeanSerializerBase) serializer, NameTransformer.NOP);
                    }
                    return serializer;
                }
            });
        }
    });
}

public class UnwrappingOrderSerializer extends UnwrappingBeanSerializer {
    public UnwrappingBarSerializer(BeanSerializerBase src, NameTransformer transformer) {
        super(src, transformer);
    }

    @Override
    public JsonSerializer<Object> unwrappingSerializer(NameTransformer transformer) {
        return new UnwrappingOrderSerializer(this, transformer);
    }

    @Override
    protected void serializeFields(Object bean, JsonGenerator jgen, SerializerProvider provider) throws IOException, JsonGenerationException {
        Order order = (Order) bean;
        jgen.writeStringField("paid", order.isPaid();
    }

    @Override
    public boolean isUnwrappingSerializer() {
        return true;
    }
}

Answer 2

投影是一种解决方案，并且覆盖JsonSerializer的另一种方法是另一种方法：

    @Override
    public boolean isUnwrappingSerializer() {
        return true;
    }

然后你应该可以省略对象的开始和结束。

查找我的博文here。

Answer 3

超越andreast00上面的解决方案 - 确保也覆盖其他构造函数和...方法，或者它可能在后台创建默认的UnwrappingBeanSerializer并忽略您的自定义序列化代码：

public UnwrappingOrderSerializer(UnwrappingBeanSerializer src, ObjectIdWriter objectIdWriter) {
    super(src, objectIdWriter);
}

public UnwrappingOrderSerializer(UnwrappingBeanSerializer src, ObjectIdWriter objectIdWriter, Object filterId) {
    super(src, objectIdWriter, filterId);
}

public UnwrappingOrderSerializer(UnwrappingBeanSerializer src, Set<String> toIgnore) {
    super(src, toIgnore);
}



@Override
public BeanSerializerBase withObjectIdWriter(ObjectIdWriter objectIdWriter) {
    return new UnwrappingOrderSerializer(this, objectIdWriter);
}

@Override
public BeanSerializerBase withFilterId(Object filterId) {
    return new UnwrappingOrderSerializer(this, this._objectIdWriter, filterId);
}

@Override
protected BeanSerializerBase withIgnorals(Set<String> toIgnore) {
    return new UnwrappingOrderSerializer(this, toIgnore);
}

此外，根据序列化是从@JsonUnwrapped对象发生，作为数组中的对象还是作为单个对象，jsonGenerater.writeStartObject可能需要在天气对象已经启动或未启动时进行调用。我用过：

boolean writeStartEnd = !jsonGenerator.getOutputContext().inObject() 
    || jsonGenerator.getOutputContext().getCurrentName() != null;

if (writeStartEnd) jsonGenerator.writeStartObject(entity);

...serialisation code...

if (writeStartEnd) {    
    jsonGenerator.writeEndObject();
}

Answer 4

我遇到了同样的问题。我没有使用Jackson Serializer，而是使用了@Projecton并定制了我的输出。您可以找到参考here

在Spring Data Rest中使用自定义json序列化程序时输出不同的JSON

4 个答案: