Что такое payload в запросе?

Payload в запросе

Payload (груз, полезная нагрузка) — это основная часть HTTP запроса или ответа, содержащая фактические данные, которые необходимо передать. Это отличается от заголовков (headers), которые содержат метаинформацию о запросе.

Структура HTTP запроса

GET /api/users?id=123 HTTP/1.1          <- Стартовая строка (без payload)
Host: api.example.com                    <- Заголовки
Content-Type: application/json
Content-Length: 42
                                          <- Пустая строка
{"name": "John", "email": "john@..."} <- Payload (тело запроса)

Когда есть payload

Запросы с payload:

• POST: создание новых ресурсов
• PUT: полное обновление ресурса
• PATCH: частичное обновление ресурса
• DELETE: может иметь payload с причиной удаления

Запросы без payload:

• GET: параметры передаются в URL
• HEAD: без payload
• DELETE: обычно без payload

Примеры payload в Java

1. POST с JSON payload

import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.URI;

public class HttpClientExample {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();
        
        // Payload (тело запроса)
        String jsonPayload = "{\"name\":\"John\",\"age\":30}";
        
        HttpRequest request = HttpRequest.newBuilder()
            .uri(new URI("https://api.example.com/users"))
            .header("Content-Type", "application/json")
            .POST(HttpRequest.BodyPublishers.ofString(jsonPayload))
            .build();
        
        HttpResponse<String> response = client.send(
            request,
            HttpResponse.BodyHandlers.ofString()
        );
        
        System.out.println("Код ответа: " + response.statusCode());
        System.out.println("Ответ (payload): " + response.body());
    }
}

2. Использование RestTemplate в Spring

import org.springframework.web.client.RestTemplate;
import org.springframework.http.HttpEntity;
import org.springframework.http.HttpHeaders;
import org.springframework.http.MediaType;

public class RestTemplateExample {
    public static void main(String[] args) {
        RestTemplate restTemplate = new RestTemplate();
        
        // Подготовить payload
        String jsonPayload = "{\"name\":\"Jane\",\"age\":25}";
        
        // Установить заголовки
        HttpHeaders headers = new HttpHeaders();
        headers.setContentType(MediaType.APPLICATION_JSON);
        
        // Создать HttpEntity с payload и заголовками
        HttpEntity<String> request = new HttpEntity<>(jsonPayload, headers);
        
        // Отправить запрос
        String response = restTemplate.postForObject(
            "https://api.example.com/users",
            request,
            String.class
        );
        
        System.out.println("Ответ (payload): " + response);
    }
}

3. Payload с объектом (сериализация)

import com.google.gson.Gson;

public class UserRequest {
    private String name;
    private int age;
    private String email;
    
    public UserRequest(String name, int age, String email) {
        this.name = name;
        this.age = age;
        this.email = email;
    }
    
    public static void main(String[] args) throws Exception {
        UserRequest user = new UserRequest("Bob", 35, "bob@example.com");
        
        // Конвертировать объект в JSON payload
        String jsonPayload = new Gson().toJson(user);
        System.out.println("Payload: " + jsonPayload);
        // Вывод: {"name":"Bob","age":35,"email":"bob@example.com"}
        
        HttpRequest request = HttpRequest.newBuilder()
            .uri(new URI("https://api.example.com/users"))
            .header("Content-Type", "application/json")
            .POST(HttpRequest.BodyPublishers.ofString(jsonPayload))
            .build();
    }
}

4. Payload с файлом (multipart/form-data)

import java.net.http.HttpRequest;
import java.nio.file.Files;
import java.nio.file.Paths;

public class FileUploadExample {
    public static void main(String[] args) throws Exception {
        byte[] fileBytes = Files.readAllBytes(Paths.get("/path/to/file.txt"));
        
        HttpRequest request = HttpRequest.newBuilder()
            .uri(new URI("https://api.example.com/upload"))
            // multipart payload для загрузки файла
            .POST(HttpRequest.BodyPublishers.ofByteArray(fileBytes))
            .header("Content-Type", "application/octet-stream")
            .build();
    }
}

Размер payload

public class PayloadSizeExample {
    public static void main(String[] args) {
        String payload = "{\"data\":\"very long data...\"}"; // Большой JSON
        
        // Заголовок Content-Length указывает размер payload
        int contentLength = payload.getBytes(StandardCharsets.UTF_8).length;
        System.out.println("Размер payload: " + contentLength + " байт");
        
        // При отправке запроса это автоматически добавляется
        HttpRequest request = HttpRequest.newBuilder()
            .uri(new URI("https://api.example.com/data"))
            .POST(HttpRequest.BodyPublishers.ofString(payload))
            .build();
    }
}

Лучшие практики

• Используй JSON: стандарт для современных API
• Проверяй размер: не отправляй огромные payload без необходимости
• Валидируй данные: перед отправкой проверь корректность payload
• Сжимай данные: для больших payload используй gzip компрессию
• Обрабатывай ошибки: неверный payload вернёт ошибку 400 Bad Request