Неизменяемый ломбокский аннотированный класс с Джексоном

добавить Свойства конструктора:

• Создайте файл lombok.config в соответствующем месте со строкой: lombok.anyConstructor.addConstructorProperties = true
• Добавьте аннотацию lombok @Value в свой класс, чтобы сделать его неизменным.

Затем сериализация и десериализация Джексоном работают, как и ожидалось.

Этот способ:

• соответствует критериям
• имеет меньше места, чем предыдущий главный ответ
• работает в v1.16.20 (9 января 2018 г.) и более поздних версиях.

Редактировать: 16 августа 2020 г.

• Примечание. Использование @Builder с @Value приводит к сбою этого решения. (Спасибо за комментарий от @guilherme-blanco ниже.) Однако, если вы также добавите, например. @AllArgsConstructor он по-прежнему работает, как ожидалось.

Вы можете использовать аннотацию Lombok @Builder для создания построителя для вашего неизменного класса POJO. Но сделать билдер, сгенерированный Lombok, пригодным для использования с помощью десериализации Джексона, довольно сложно.

• Вам необходимо аннотировать свой класс POJO с помощью @JsonDeserialize(builder = ...) чтобы сообщить Джексону, какой класс строителя использовать.
• Вам необходимо аннотировать класс построителя с помощью @JsonPOJOBuilder(withPrefix = ""), чтобы сообщить Джексону, что его методы установки не начинаются с with.

Пример:

Неизменяемый класс POJO:

@Data
@Builder(builderClassName = "PointBuilder")
@JsonDeserialize(builder = Point.PointBuilder.class)
public class Point {

    private final int x;

    private final int y;

    @JsonPOJOBuilder(withPrefix = "")
    public static class PointBuilder {
        // Lombok will add constructor, setters, build method
    }
}

Вот тест JUnit для проверки сериализации/десериализации:

public class PointTest extends Assert {

    private ObjectMapper objectMapper = new ObjectMapper();

    @Test
    public void testSerialize() throws IOException {
        Point point = new Point(10, 20);
        String json = objectMapper.writeValueAsString(point);
        assertEquals("{\"x\":10,\"y\":20}", json);
    }

    @Test
    public void testDeserialize() throws IOException {
        String json = "{\"x\":10,\"y\":20}";
        Point point = objectMapper.readValue(json, Point.class);
        assertEquals(new Point(10, 20), point);
    }
}

По состоянию на 15 октября 2020 г. (Lombok v1.18.16) вы должны просто иметь возможность использовать аннотацию @Jacksonized.

@Jacksonized @Builder
@JsonIgnoreProperties(ignoreUnknown = true)
public class JacksonExample {
  private List<Foo> foos;
}

Как описано в связанной документации, эта аннотация:

• настраивает Джексона на использование построителя для десериализации,
• копирует специфичную для поля конфигурацию из аннотированного класса в сгенерированный построитель (например, @JsonIgnoreProperties) и
• выравнивает префикс Джексона, используемый в методах построения (например, builder().withField(field) против builder.field(field), с тем, который настроен в Lombok.

Ссылаясь на ответ Джозефа К. Штрауса, я нашел следующее решение.

Простые аннотации ломбока, которые у меня сработали, выглядят так. Следующие аннотации дают вам неизменяемые классы с построителем, которые могут быть сериализованы и десериализованы Джексоном.

    @Data
    @Setter(AccessLevel.NONE)
    @Builder(toBuilder = true)
    @AllArgsConstructor
    @NoArgsConstructor(access = AccessLevel.PRIVATE)
    public class Clazz {
        private String field;
    } 

Я предпочитаю это решение, потому что оно не требует дополнительных специальных аннотаций Джексона и дополнительных специфические файлы ломбока

Другая альтернатива, которая гораздо менее подробна:

@Data
@Setter(AccessLevel.NONE)
public class Clazz {
    private String field;
} 

Конечно, у вас все еще может быть какой-то закрытый метод, который напрямую изменяет поле, но очень маловероятно, что в @Data POJO будет даже какой-то реальный код, так что, надеюсь, этого не произойдет.

Отказ от ответственности: это будет иметь побочный эффект (возможно, полезный), не позволяя обычному коду Java создавать объект, поскольку существует только конструктор по умолчанию без мутаторов. Для нормального построения вам понадобятся еще 2 аннотации:

@Data
@AllArgsConstructor
@NoArgsConstructor
@Setter(AccessLevel.NONE)
public class Clazz {
    private String field;
} 

Попробуйте следующий набор аннотаций для вашего pojo:

@Value
@NoArgsConstructor(force = true, access = AccessLevel.PRIVATE)
@AllArgsConstructor

Самый простой способ настроить неизменяемый класс для Джексона — использовать аннотацию ломбока: @Value и @Jacksonized:

    @Jacksonized
    @Builder
    @Value
    class Foo {

        
    }

Я только что решил это, используя этот способ:

@Value
@Builder(setterPrefix = "with")
@JsonDeserialize(builder = Clazz.ClazzBuilder.class)
public class Clazz {
    private String field;
}

В этом случае вы должны использовать методы построения, такие как withField(...), что является поведением по умолчанию, используемым jackson.

Ответ Томаса Фрича отлично работал с Spring Boot после добавления зависимости Jackson Dataformat в pom.

@Data
@Builder(builderClassName = "PointBuilder")
@JsonDeserialize(builder = Point.PointBuilder.class)
public class Point {

    private final int x;

    private final int y;

    @JsonPOJOBuilder(withPrefix = "")
    public static class PointBuilder {
        // Lombok will add constructor, setters, build method
    }
}

<!-- https://mvnrepository.com/artifact/com.fasterxml.jackson.dataformat/jackson-dataformat-xml -->
<dependency>
    <groupId>com.fasterxml.jackson.dataformat</groupId>
    <artifactId>jackson-dataformat-xml</artifactId>
</dependency>