Кодирование URL параметров запроса в Java: как правильно?

Правильное кодирование URL параметров в Java

Вы на верном пути, используя URLEncoder.encode(), но есть важные нюансы. Давайте разберёмся по порядку.

1. Что делает URLEncoder.encode()?

Метод URLEncoder.encode() преобразует строку в формат application/x-www-form-urlencoded, который используется в HTTP-запросах (как в GET, так и в POST с form-data). В этом формате пробел кодируется как +, а не как %20. Это стандартное поведение для параметров запроса. Таким образом, Java+%26+Spring+Framework — абсолютно корректный результат.

2. Нужно ли кодировать весь URL?

Нет, никогда не кодируйте весь URL целиком! Вы должны кодировать только значения параметров (и иногда имена, если они содержат спецсимволы). Если вы закодируете весь URL, то сломаете его структуру: ://, /, ? и & тоже будут закодированы, и URL перестанет работать.

3. Как правильно собрать URL с параметрами?

Вот правильный подход:

import java.net.URLEncoder;
import java.nio.charset.StandardCharsets;

public class UrlBuilder {
    public static void main(String[] args) throws Exception {
        String baseUrl = "https://api.example.com/search";
        String queryParam = "Java & Spring Framework";
        String langParam = "ru";

        // Кодируем каждое значение параметра отдельно
        String encodedQuery = URLEncoder.encode(queryParam, StandardCharsets.UTF_8);
        String encodedLang = URLEncoder.encode(langParam, StandardCharsets.UTF_8);

        // Собираем URL
        String fullUrl = baseUrl + "?q=" + encodedQuery + "&lang=" + encodedLang;

        System.out.println(fullUrl);
        // Вывод: https://api.example.com/search?q=Java+%26+Spring+Framework&lang=ru
    }
}

4. Использование библиотек (рекомендуемый способ)

В реальных проектах лучше использовать готовые библиотеки, которые обрабатывают кодирование автоматически. Например, Apache HttpClient или OkHttp. Вот пример с java.net.URI и URIBuilder (из Apache HttpComponents):

import org.apache.http.client.utils.URIBuilder;
import java.net.URI;

public class SafeUrlBuilder {
    public static void main(String[] args) throws Exception {
        URI uri = new URIBuilder("https://api.example.com/search")
                .setParameter("q", "Java & Spring Framework")
                .setParameter("lang", "ru")
                .build();

        System.out.println(uri.toString());
        // Вывод: https://api.example.com/search?q=Java+%26+Spring+Framework&lang=ru
    }
}

Библиотека сама позаботится о кодировании всех значений.

5. Что делать с пробелами: '+' или '%20'?

Оба варианта допустимы, но:

• + — это стандарт для application/x-www-form-urlencoded (параметры в query string).
• %20 — это стандарт для application/x-www-form-urlencoded в других частях URL (например, в пути).

Большинство серверов принимают оба варианта. Если вы используете URLEncoder.encode(), вы получите +, и это нормально.

6. Важные предостережения

• Всегда указывайте кодировку (UTF-8). В Java 10+ можно использовать StandardCharsets.UTF_8.
• Кодируйте каждый параметр отдельно, а не всю строку запроса целиком.
• Не кодируйте имена параметров, если они не содержат спецсимволов. В противном случае кодируйте и их.
• Избегайте ручной конкатенации строк для сложных URL — используйте библиотеки.

В итоге ваш исходный код с URLEncoder.encode() был почти правильным. Главное — не кодируйте весь URL, а только значения.

import java.net.URLEncoder;
import java.nio.charset.StandardCharsets;

public class CustomUrlEncoder {
    public static String encodeValue(String value) {
        String encoded = URLEncoder.encode(value, StandardCharsets.UTF_8);
        // Заменяем '+' на '%20' (если нужно)
        return encoded.replace("+", "%20");
    }

    public static void main(String[] args) {
        String query = "Java & Spring Framework";
        String encoded = encodeValue(query);
        System.out.println(encoded); // Java%20%26%20Spring%20Framework
    }
}

import java.net.URI;
import java.net.URLEncoder;

public class UriExample {
    public static void main(String[] args) throws Exception {
        String base = "https://example.com/search";
        String param = "q=" + URLEncoder.encode("Java & Spring", "UTF-8");
        URI uri = new URI(base + "?" + param);
        System.out.println(uri.toASCIIString());
    }
}