Ефективна фільтрація полів JSON у Spring Boot з використанням анотації @JsonView

5 Березня 2024 в 20:55 125

У сучасній розробці веб-додатків важливу роль відіграє оптимізація обміну даними між клієнтом і сервером. Одним з підходів до оптимізації є фільтрація даних, що серіалізуються, з метою зменшення обсягу переданих даних. В екосистемі Spring Boot для цього часто застосовується бібліотека Jackson, яка дозволяє гнучко управляти процесом серіалізації об’єктів у формат JSON. Особливо ефективним механізмом у цьому контексті є використання анотації @JsonView.

Що таке `@JsonView`?

Анотація @JsonView в Jackson дозволяє вказати, які саме поля об’єкта мають бути включені до результату серіалізації у JSON. Це робить можливим використання одного і того ж класу для генерації різних представлень даних в залежності від контексту їх використання.

Проблематика

Розробники часто стикаються з викликом: як забезпечити гнучкість відображення даних без необхідності створення множини DTO (Data Transfer Object) для різних сценаріїв використання? Водночас, існує потреба у зменшенні кількості передаваних даних між сервером і клієнтом для підвищення продуктивності та зменшення навантаження на мережу. Вирішенням може стати динамічна фільтрація полів об’єктів при серіалізації.

Як налаштувати `@JsonView` в Spring Boot

Використання @JsonView починається з визначення одного або декількох інтерфейсів, які виступатимуть як маркери для різних представлень даних. Після цього, полям в POJO (Plain Old Java Object) присвоюються відповідні анотації @JsonView, що індикує, до яких представлень ці поля мають бути включені.

// Визначення інтерфейсів для представлень
public interface Views {
    interface Public {}
    interface Internal extends Public {}
}
// Використання @JsonView в POJO
public class User {
    @JsonView(Views.Public.class)
    private Long id;
    @JsonView(Views.Public.class)
    private String name;
    @JsonView(Views.Internal.class)
    private String emailAddress;
    
    // Гетери та сетери
}

// Визначення інтерфейсів для представлень

public interface Views {

interface Public {}

interface Internal extends Public {}

}

// Використання @JsonView в POJO

public class User {

@JsonView(Views.Public.class)

private Long id;

@JsonView(Views.Public.class)

private String name;

@JsonView(Views.Internal.class)

private String emailAddress;

// Гетери та сетери

}

У контролерах Spring MVC або Spring WebFlux можна додатково вказати, яке саме представлення має бути використане при серіалізації відповіді. Це досягається за допомогою анотації @JsonView на рівні методу.

@RestController
public class UserController {
    @GetMapping("/user/{id}")
    @JsonView(Views.Public.class)
    public ResponseEntity<User> getUserById(@PathVariable Long id) {
        User user = userService.findById(id);
        return ResponseEntity.ok(user);
    }
}

@RestController

public class UserController {

@GetMapping("/user/{id}")

@JsonView(Views.Public.class)

public ResponseEntity<User> getUserById(@PathVariable Long id) {

User user = userService.findById(id);

return ResponseEntity.ok(user);

}

Вирішення проблеми

Щодо поставленого запитання про можливість фінерування серіалізації на рівні контролера: Spring Boot дозволяє деталізувати процес серіалізації, використовуючи @JsonView без необхідності маркування кожного поля в кожному POJO. Можна налаштувати серіалізацію так, щоб за замовчуванням були серіалізовані всі поля, але якщо поле анотовано @JsonView, то воно буде серіалізовано лише при використанні відповідного представлення. Цей підхід забезпечує баланс між гнучкістю та ефективністю, дозволяючи розробникам контролювати обсяг серіалізованих даних без необхідності переписування існуючого коду.

Заключне слово

Анотація @JsonView у Spring Boot є потужним інструментом для оптимізації обміну даними між сервером і клієнтом. Вона дозволяє ефективно управляти тим, які дані включаються до відповіді сервера, забезпечуючи гнучкість та високу продуктивність веб-додатків. Використовуючи @JsonView, розробники можуть значно спростити управління різними рівнями видимості даних, що є ключовим аспектом при створенні масштабованих і безпечних веб-додатків.