有 Java 编程相关的问题?

你可以在下面搜索框中键入要查询的问题!

java如何使Jackson序列化程序更加干燥?

我使用ember.js作为客户端框架。开箱即用,这个框架需要某种格式的JSON。我想让Jackson输出那种格式。这对于回答这个问题并不重要,但提到了它并对其进行了标记,因为它可能会在相同情况下帮助更多用户

基本上,我希望每个被引用的对象(不是根对象)都被输出为它们的id。我将给你一个简单的例子。 这些课程:

public abstract class BaseEntity{
    protected Long id;
}

public class Resource{
    private String name;
    private AnotherResource subResource;
    private List<AnotherResource> subResources;

    //getters and setters
}

public class SubResource{
    private String value;

    //getters and setters
}

通过以下示例:

// Sub resources
SubResource sr1 = new SubResource();
sr1.setId(2);
sr1.setValue("some string");
SubResource sr2 = new SubResource();
sr2.setId(3);
sr2.setValue("some string");
SubResource sr3 = new SubResource();
sr3.setId(4);
sr3.setValue("some string");
// resource
Resource r = new Resource();
r.setId(1);
r.setName("bla");
r.setSubResource(sr1);
ArrayList<SubResource> list = new ArrayList<SubResource>();
list.add(sr1);
list.add(sr2);
list.add(sr3);
r.setSubResources(list);

序列化r应输出:

{
    "resource":{
        "id": 1,
        "name": "bla",
        "sub_resource_id": 2,
        "sub_resource_ids": [
            1,
            2,
            3
        ]
    }
}

我们可以注意到以下几点

  1. 键名与"_id""_ids"连接,这取决于它是被引用对象还是被引用对象的集合
  2. 只有被引用对象的id被序列化
  3. 对于引用对象的集合,它们的ID数组被序列化

关于属性名(1),我已经用@JsonProperty注释解决了这个问题

至于其余部分,我编写了以下序列化程序:

public class BaseEntityIdSerializer extends JsonSerializer<BaseEntity> implements ContextualSerializer {

    public void serialize(BaseEntity value, JsonGenerator jgen,
            SerializerProvider provider) throws IOException,
            JsonProcessingException {
    }

    @Override
    public void serializeWithType(BaseEntity value, JsonGenerator jgen,
            SerializerProvider provider, TypeSerializer typeSer)
            throws IOException, JsonProcessingException {
        serialize(value, jgen, provider);
    }

    @Override
    public JsonSerializer<?> createContextual(SerializerProvider prov,
            BeanProperty property) throws JsonMappingException {
        if(property.getType().isCollectionLikeType()){
            return new BaseEntityIdCollectionSerializer();
        } else {
            return new BaseEntityIdSimpleSerializer();
        }
    }

    public class BaseEntityIdSimpleSerializer extends StdSerializer<BaseEntity>{

        public BaseEntityIdSimpleSerializer(){
            super(BaseEntity.class);
        }

        @Override
        public void serialize(BaseEntity value, JsonGenerator jgen,
                SerializerProvider provider) throws IOException,
                JsonGenerationException {
            jgen.writeNumber(value.getId());
        }

        @Override
        public void serializeWithType(BaseEntity value, JsonGenerator jgen,
                SerializerProvider provider, TypeSerializer typeSer)
                throws IOException, JsonProcessingException {
            serialize(value, jgen, provider);
        }
    }

    public class BaseEntityIdCollectionSerializer extends StdSerializer<Collection<? extends BaseEntity>>{

        public BaseEntityIdCollectionSerializer(){
            super(Collection.class, false);
        }

        @Override
        public void serialize(Collection<? extends BaseEntity> value,
                JsonGenerator jgen, SerializerProvider provider)
                throws IOException, JsonGenerationException {
            jgen.writeStartArray();
            for(BaseEntity b:value){
                jgen.writeNumber(b.getId());
            }
            jgen.writeEndArray();
        }

        @Override
        public void serializeWithType(Collection<? extends BaseEntity> value, JsonGenerator jgen,
                SerializerProvider provider, TypeSerializer typeSer)
                throws IOException, JsonProcessingException {
            serialize(value, jgen, provider);
        }
    }
}

然后用@JsonSerialize(using=BaseEntityIdSerializer.class)

这就行了。输出正确的JSON。但是我觉得我在重复很多代码。例如,我正在为集合和单个对象编写不同的序列化程序类。我希望多次使用单个序列化程序。更可组合的东西。 显然,我使用了错误的类来解析序列化程序(我被迫实现serialize,但我什么也不做)

你的见解是什么?如何改进此序列化程序? 此外,是否可以在序列化程序中处理属性名(连接“_id”)?这样我就不用@JsonProperty注释了

谢谢


共 (1) 个答案

  1. # 1 楼答案

    我不确定您是否真的需要定义自定义序列化程序:值序列化程序是否可以正常工作?Jackson确实可以自动合成这些内容(并覆盖匹配的数组序列化程序)。所以对于集合case,return this;应该适用于上下文case

    属性重命名在值序列化程序级别不起作用,因为这取决于POJO序列化程序(BeanSerializer)。也就是说,值序列化程序不会写入属性名(如果必要,对于JSON对象,已经调用了属性名;对于JSON数组,已经省略了根级别的值)。 这是设计的一部分,Jackson 1.0的不同结构可能是有意义的(让值序列化程序有两个方法;一个用于数组元素的“简单”值,根级别;第二个用于“命名”属性值),但现在改变已经太晚了

    但是:您可以通过以下方式在序列化程序之外处理重命名:

    • 自定义JacksonAnnotationIntrospector,使用类型信息修改名称以进行序列化或反序列化,或同时进行(分别调用)
    • 通过BeanSerializerModifier,在其中一个回调上以类似方式重命名属性