Как преобразовать карту в строку запроса url?

Знаете ли вы о каком-либо служебном классе/библиотеке, которые могут конвертировать Map в строку запроса, удобную для URL?

Пример:

У меня есть карта:

"param1"=12,
"param2"="cat"

Я хочу получить:

param1=12&param2=cat

окончательный вывод

relativeUrl+param1=12&param2=cat

Ответ 1

Самым надежным из всех, что я видел в продаже, является класс URLEncodedUtils из Apache Http Compoments (HttpClient 4.0).

Метод URLEncodedUtils.format() - это то, что вам нужно.

Он не использует карту, поэтому вы можете иметь повторяющиеся имена параметров, например,

  a=1&a=2&b=3

Не то чтобы я рекомендовал этот вид использования имен параметров.

Ответ 2

Здесь что-то, что я быстро написал; Я уверен, что его можно улучшить.

import java.util.*;
import java.io.UnsupportedEncodingException;
import java.net.URLEncoder;

public class MapQuery {
    static String urlEncodeUTF8(String s) {
        try {
            return URLEncoder.encode(s, "UTF-8");
        } catch (UnsupportedEncodingException e) {
            throw new UnsupportedOperationException(e);
        }
    }
    static String urlEncodeUTF8(Map<?,?> map) {
        StringBuilder sb = new StringBuilder();
        for (Map.Entry<?,?> entry : map.entrySet()) {
            if (sb.length() > 0) {
                sb.append("&");
            }
            sb.append(String.format("%s=%s",
                urlEncodeUTF8(entry.getKey().toString()),
                urlEncodeUTF8(entry.getValue().toString())
            ));
        }
        return sb.toString();       
    }
    public static void main(String[] args) {
        Map<String,Object> map = new HashMap<String,Object>();
        map.put("p1", 12);
        map.put("p2", "cat");
        map.put("p3", "a & b");         
        System.out.println(urlEncodeUTF8(map));
        // prints "p3=a+%26+b&p2=cat&p1=12"
    }
}

Ответ 3

Я нашел гладкое решение с использованием решения java 8 и полигенных смазочных материалов.

parameters.entrySet().stream()
    .map(p -> urlEncodeUTF8(p.getKey()) + "=" + urlEncodeUTF8(p.getValue()))
    .reduce((p1, p2) -> p1 + "&" + p2)
    .orElse("");

Ответ 4

В Spring Util, есть лучший способ..,

import org.springframework.util.LinkedMultiValueMap;
import org.springframework.util.MultiValueMap;
import org.springframework.util.concurrent.ListenableFuture;
import org.springframework.web.util.UriComponents;
import org.springframework.web.util.UriComponentsBuilder;

MultiValueMap<String, String> params = new LinkedMultiValueMap<String, String>();
params.add("key", key);
params.add("storeId", storeId);
params.add("orderId", orderId);
UriComponents uriComponents =     UriComponentsBuilder.fromHttpUrl("http://spsenthil.com/order").queryParams(params).build();
ListenableFuture<ResponseEntity<String>> responseFuture =     restTemplate.getForEntity(uriComponents.toUriString(), String.class);

Ответ 5

Обновление Июнь 2016

Чувствовал себя вынужденным добавить ответ, увидев слишком много ответов SOF с датированными или неадекватными ответами на очень распространенную проблему - хорошую библиотеку и примерное использование примера для операций parse и format.

Используйте org.apache.httpcomponents.httpclient библиотеку. Библиотека содержит эту утилиту класса org.apache.http.client.utils.URLEncodedUtils.

Например, легко загрузить эту зависимость из Maven:

 <dependency>
    <groupId>org.apache.httpcomponents</groupId>
    <artifactId>httpclient</artifactId>
    <version>4.5</version>
 </dependency>

Для моих целей мне понадобилось только parse (чтение из строки запроса в пар имя-значение) и строки format (чтение из строки name-value в строку запроса) строки запроса. Однако существуют эквиваленты для того, чтобы сделать то же самое с URI (см. Пронумерованную строку ниже).

//Требуемый импорт

import org.apache.http.NameValuePair;
import org.apache.http.client.utils.URLEncodedUtils;
import java.io.UnsupportedEncodingException;
import java.net.URLDecoder;
import java.nio.charset.StandardCharsets;

//фрагмент кода

public static void parseAndFormatExample() throws UnsupportedEncodingException {
        final String queryString = "nonce=12345&redirectCallbackUrl=http://www.bbc.co.uk";
        System.out.println(queryString);
        // => nonce=12345&redirectCallbackUrl=http://www.bbc.co.uk

        final List<NameValuePair> params =
                URLEncodedUtils.parse(queryString, StandardCharsets.UTF_8);
        // List<NameValuePair> params = URLEncodedUtils.parse(new URI(url), "UTF-8");

        for (final NameValuePair param : params) {
            System.out.println(param.getName() + " : " + param.getValue());
            // => nonce : 12345
            // => redirectCallbackUrl : http://www.bbc.co.uk
        }

        final String newQueryStringEncoded =
                URLEncodedUtils.format(params, StandardCharsets.UTF_8);


        // decode when printing to screen
        final String newQueryStringDecoded =
                URLDecoder.decode(newQueryStringEncoded, StandardCharsets.UTF_8.toString());
        System.out.println(newQueryStringDecoded);
        // => nonce=12345&redirectCallbackUrl=http://www.bbc.co.uk
    }

Эта библиотека сделала именно то, что мне было нужно, и смогла заменить какой-то взломанный пользовательский код.

Ответ 6

Если вы действительно хотите создать полный URI, попробуйте URIBuilder из Apache Http Compoments (HttpClient 4).

Это на самом деле не отвечает на вопрос, но ответ на тот вопрос, который у меня был, когда я нашел этот вопрос.

Ответ 7

Еще один "один класс"/нет зависимости способ сделать это, обрабатывая один/несколько:

import java.io.UnsupportedEncodingException;
import java.net.URLEncoder;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Iterator;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;

public class UrlQueryString {
  private static final String DEFAULT_ENCODING = "UTF-8";

  public static String buildQueryString(final LinkedHashMap<String, Object> map) {
    try {
      final Iterator<Map.Entry<String, Object>> it = map.entrySet().iterator();
      final StringBuilder sb = new StringBuilder(map.size() * 8);
      while (it.hasNext()) {
        final Map.Entry<String, Object> entry = it.next();
        final String key = entry.getKey();
        if (key != null) {
          sb.append(URLEncoder.encode(key, DEFAULT_ENCODING));
          sb.append('=');
          final Object value = entry.getValue();
          final String valueAsString = value != null ? URLEncoder.encode(value.toString(), DEFAULT_ENCODING) : "";
          sb.append(valueAsString);
          if (it.hasNext()) {
            sb.append('&');
          }
        } else {
          // Do what you want...for example:
          assert false : String.format("Null key in query map: %s", map.entrySet());
        }
      }
      return sb.toString();
    } catch (final UnsupportedEncodingException e) {
      throw new UnsupportedOperationException(e);
    }
  }

  public static String buildQueryStringMulti(final LinkedHashMap<String, List<Object>> map) {
    try {
      final StringBuilder sb = new StringBuilder(map.size() * 8);
      for (final Iterator<Entry<String, List<Object>>> mapIterator = map.entrySet().iterator(); mapIterator.hasNext();) {
        final Entry<String, List<Object>> entry = mapIterator.next();
        final String key = entry.getKey();
        if (key != null) {
          final String keyEncoded = URLEncoder.encode(key, DEFAULT_ENCODING);
          final List<Object> values = entry.getValue();
          sb.append(keyEncoded);
          sb.append('=');
          if (values != null) {
            for (final Iterator<Object> listIt = values.iterator(); listIt.hasNext();) {
              final Object valueObject = listIt.next();
              sb.append(valueObject != null ? URLEncoder.encode(valueObject.toString(), DEFAULT_ENCODING) : "");
              if (listIt.hasNext()) {
                sb.append('&');
                sb.append(keyEncoded);
                sb.append('=');
              }
            }
          }
          if (mapIterator.hasNext()) {
            sb.append('&');
          }
        } else {
          // Do what you want...for example:
          assert false : String.format("Null key in query map: %s", map.entrySet());
        }
      }
      return sb.toString();
    } catch (final UnsupportedEncodingException e) {
      throw new UnsupportedOperationException(e);
    }
  }

  public static void main(final String[] args) {
    // Examples: could be turned into unit tests ...
    {
      final LinkedHashMap<String, Object> queryItems = new LinkedHashMap<String, Object>();
      queryItems.put("brand", "C&A");
      queryItems.put("count", null);
      queryItems.put("misc", 42);
      final String buildQueryString = buildQueryString(queryItems);
      System.out.println(buildQueryString);
    }
    {
      final LinkedHashMap<String, List<Object>> queryItems = new LinkedHashMap<String, List<Object>>();
      queryItems.put("usernames", new ArrayList<Object>(Arrays.asList(new String[] { "bob", "john" })));
      queryItems.put("nullValue", null);
      queryItems.put("misc", new ArrayList<Object>(Arrays.asList(new Integer[] { 1, 2, 3 })));
      final String buildQueryString = buildQueryStringMulti(queryItems);
      System.out.println(buildQueryString);
    }
  }
}

Вы можете использовать либо простой (проще писать в большинстве случаев), либо множественный при необходимости. Обратите внимание, что оба могут быть объединены путем добавления амперсанда... Если вы обнаружите какие-либо проблемы, дайте мне знать в комментариях.

Ответ 8

Я хотел бы построить ответ @eclipse, используя отображение и сокращение java 8.

protected String formatQueryParams(Map<String, String> params) {
  return params.entrySet().stream()
      .map(p -> p.getKey() + "=" + p.getValue())
      .reduce((p1, p2) -> p1 + "&" + p2)
      .map(s -> "?" + s)
      .orElse("");

}

Дополнительная операция map принимает приведенную строку и помещает ? впереди, только если строка существует.

Ответ 9

Это решение, которое я реализовал, используя Java 8 и org.apache.http.client.URLEncodedUtils. Он отображает записи карты в список BasicNameValuePair, а затем использует Apache URLEncodedUtils, чтобы превратить это в строку запроса.

List<BasicNameValuePair> nameValuePairs = params.entrySet().stream()
   .map(entry -> new BasicNameValuePair(entry.getKey(), entry.getValue()))
   .collect(Collectors.toList());

URLEncodedUtils.format(nameValuePairs, Charset.forName("UTF-8"));

Ответ 10

Чтобы немного улучшить ответ @eclipse: в Javaland карта параметров запроса обычно представляется как Map<String, String[]>, a Map<String, List<String>> или, возможно, какой-то MultiValueMap<String, String>, который является своего рода одним и тем же. В любом случае: параметр обычно может иметь несколько значений. Таким образом, решение Java 8 было бы следующим:

public String getQueryString(HttpServletRequest request, String encoding) {
    Map<String, String[]> parameters = request.getParameterMap();

    return parameters.entrySet().stream()
            .flatMap(entry -> encodeMultiParameter(entry.getKey(), entry.getValue(), encoding))
            .reduce((param1, param2) -> param1 + "&" + param2)
            .orElse("");
}

private Stream<String> encodeMultiParameter(String key, String[] values, String encoding) {
    return Stream.of(values).map(value -> encodeSingleParameter(key, value, encoding));
}

private String encodeSingleParameter(String key, String value, String encoding) {
    return urlEncode(key, encoding) + "=" + urlEncode(value, encoding);
}

private String urlEncode(String value, String encoding) {
    try {
        return URLEncoder.encode(value, encoding);
    } catch (UnsupportedEncodingException e) {
        throw new IllegalArgumentException("Cannot url encode " + value, e);
    }
}

Ответ 11

Там нет ничего встроенного в Java, чтобы сделать это. Но, эй, Java - это язык программирования, так что... позвольте ему программировать!

map.values().stream().map(e -> e.getKey() + "=" + e.getValue()).collect(Collectors.joining("&"))

Это дает вам "param1 = 12 & param2 = cat". Теперь нам нужно объединить URL и этот бит вместе. Вы думаете, что вы можете просто сделать: URL + "?" + theAbove URL + "?" + theAbove но если URL-адрес уже содержит вопросительный знак, вместо этого вы должны объединить все это вместе с "&". Один из способов проверить это - посмотреть, есть ли где-нибудь вопросительный знак в URL.

Кроме того, я не совсем знаю, что на вашей карте. Если это необработанный материал, вы, вероятно, должны защитить вызов e.getKey() и e.getValue() с помощью URLEncoder.encode или аналогичного.

Еще один способ пойти дальше, это то, что вы принимаете более широкий взгляд. Вы пытаетесь добавить содержимое карты к URL-адресу или... вы пытаетесь сделать HTTP (S) -запрос от процесса java с содержимым на карте как (дополнительными) HTTP-параметрами? В последнем случае вы можете заглянуть в http-библиотеку, например OkHttp, в которой есть несколько хороших API-интерфейсов для этой работы, а затем вы можете отказаться от необходимости возиться с этим URL-адресом.

Ответ 12

Для этого вы можете использовать Stream, но вместо добавления параметров запроса я бы использовал Uri.Builder. Например:

final Map<String, String> map = new HashMap<>();
map.put("param1", "cat");
map.put("param2", "12");

final Uri uri = 
    map.entrySet().stream().collect(
        () -> Uri.parse("relativeUrl").buildUpon(),
        (builder, e) -> builder.appendQueryParameter(e.getKey(), e.getValue()),
        (b1, b2) -> { throw new UnsupportedOperationException(); }
    ).build();

//Or, if you consider it more readable...
final Uri.Builder builder = Uri.parse("relativeUrl").buildUpon();
map.entrySet().forEach(e -> builder.appendQueryParameter(e.getKey(), e.getValue())
final Uri uri = builder.build();

//...    

assertEquals(Uri.parse("relativeUrl?param1=cat&param2=12"), uri);

Ответ 13

Лично я бы пошел на подобное решение, оно невероятно похоже на решение, предоставляемое @rzwitserloot, только с небольшими отличиями.

Это маленькое, простое и чистое решение, оно требует очень мало с точки зрения зависимостей, которые являются частью пакета Java Util.

Map<String, String> map = new HashMap<>();

map.put("param1", "12");
map.put("param2", "cat");

String output = "someUrl?";
output += map.entrySet()
    .stream()
    .map(x -> x.getKey() + "=" + x.getValue() + "&")
    .collect(Collectors.joining("&"));

System.out.println(output.substring(0, output.length() -1));

Ответ 14

Использование EntrySet и Streams:

map
  .entrySet()
  .stream()
  .map(e -> e.getKey() + "=" + e.getValue())
  .collect(Collectors.joining("&"));

Ответ 15

Я думаю, что это лучше для использования памяти и производительности, и я хочу отправить только имя свойства, когда значение равно нулю.

public static String toUrlEncode(Map<String, Object> map) {
    StringBuilder sb = new StringBuilder();
    map.entrySet().stream()
            .forEach(entry
                    -> (entry.getValue() == null
                    ? sb.append(entry.getKey())
                    : sb.append(entry.getKey())
                            .append('=')
                            .append(URLEncoder.encode(entry.getValue().toString(), StandardCharsets.UTF_8)))
                    .append('&')
            );
    sb.delete(sb.length() - 1, sb.length());
    return sb.toString();
}

Ответ 16

Groovy Способ сделать это:

map.collect{k, v -> "$k=$v"}.join("&")