Извлечение JSON POST данных из HttpServletRequest в Java

Быстрый ответ

Извлечение JSON из HttpServletRequest может быть выполнено следующим образом:

Scanner scanner = new Scanner(request.getInputStream(), "UTF-8");
String jsonData = scanner.useDelimiter("\\A").next();
scanner.close();

Несколько строк кода, и в наших руках входящий JSON в форме единой строки, полученной с помощью Scanner. Использование \\A в качестве регулярного выражения, которое обозначает начало ввода, позволяет извлечь весь контент сразу. Затем строку можно десериализовать в объект, используя библиотеки Jackson или Gson.

Преобразуем JSON в объект Java с помощью Jackson и Gson

После того, как мы получили JSON в виде строки, мы можем преобразовать его в объект Java, используя библиотеки Gson или Jackson.

Jackson

ObjectMapper objectMapper = new ObjectMapper();
MyClass myObject = objectMapper.readValue(jsonData, MyClass.class);

Подробнее об этом расскажет наш спикер на видео

Gson

Gson gson = new Gson();
MyClass myObject = gson.fromJson(jsonData, MyClass.class);

Так, строка JSON преобразуется в объект Java типа MyClass, с которым затем можно успешно работать.

Обработка исключений: преодолевайте "простуды" в блоках try-catch

При работе с JSON возможны ошибки. В таких случаях на помощь придет обработка исключений.

try {
    JSONObject jsonObject = new JSONObject(jsonData);
    // Работа с JSON-объектом, например, используем: jsonObject.getInt(), jsonObject.getString() и т.д.
} catch (JSONException e) {
    // Обрабатываем исключения JSONException
}

Таким образом, даже если возникнет ошибка, приложение умеет правильно обрабатывать исключения и продолжает свою работу.

Проверка Content-Type

Перед работой с JSON важно убедиться, что тип контента запроса соответствует application/json; charset=UTF-8.

if ("application/json; charset=UTF-8".equals(request.getContentType())) {
    // Обрабатываем JSON-запрос
}

Такая проверка поможет избежать ошибок, связанных с некорректным типом контента.

Визуализация

Давайте представим процесс работы с входящими данными JSON как создание произведения искусства:

// Извлечение потока байтов (необработанные данные POST)
InputStream inputStream = request.getInputStream();

// Чтение и преобразование данных (обработка потока)
StringBuilder builder = new StringBuilder();
try (BufferedReader reader = new BufferedReader(new InputStreamReader(inputStream))) {
    String line;
    while ((line = reader.readLine()) != null) {
        builder.append(line);
    }
}

// В результате получаем строку JSON
String jsonData = builder.toString();

Процесс преобразования можно описать следующим образом:

Необработанные данные POST (🖌️ Основа для рисунка)
          ↓
InputStream (🎨 Нанесение первых линий)
          ↓
StringBuilder (🔍 Детализация)
          ↓
Строка JSON (🏆 Готовая картина)

Ограничения getParameter(): не подходит для работы с JSON

Метод getParameter() из HttpServletRequest не предназначен для извлечения данных JSON; он используется для контента типа application/x-www-form-urlencoded. Для работы с JSON рекомендуется использовать другие методы, например, getReader().

Путаница с кодировкой: использовать UTF-8 для специальных символов

Соблюдение корректной кодировки имеет важное значение при обработке специальных символов. Используя UTF-8, мы обеспечиваем правильное представление данных.

BufferedReader reader = new BufferedReader(new InputStreamReader(inputStream, StandardCharsets.UTF_8));

Теперь специальные символы будут обработаны верно!

Полезные материалы

1. Http Servlet request lose params from POST body after read it once (Stack Overflow) – Подробности об чтении тела запросов в сервлетах Java.
2. HttpServletRequest (Java(TM) EE 7 Specification APIs) – Документация HttpServletRequest.
3. Android Reading from an Input stream efficiently (Stack Overflow) – Советы по эффективному чтению из InputStream.
4. Введение в библиотеку Gson (Baeldung) – Об использовании библиотеки Gson для работы с JSON в Java.
5. HttpServletResponse get JSON POST data (Stack Overflow) – Обсуждение методов получения данных JSON из HttpServletRequest.