89

您知道任何可以将 Map 转换为 URL 友好查询字符串的实用程序类/库吗?

例子:

我有一张地图:

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

我想得到:

param1=12&param2=cat

最终输出

relativeUrl+param1=12&param2=cat
4

18 回答 18

71

我看到的现成的最强大的是来自Apache Http Compoments (HttpClient 4.0)的URLEncodedUtils类。

该方法URLEncodedUtils.format()是您需要的。

它不使用地图,因此您可以使用重复的参数名称,例如,

  a=1&a=2&b=3

并不是说我推荐这种使用参数名称。

于 2010-05-11T12:00:27.503 回答
45

这是我很快写的东西;我相信它可以改进。

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"
    }
}
于 2010-05-11T11:09:08.780 回答
42

我使用 java 8 和 polygenelubricants 的解决方案找到了一个平滑的解决方案。

parameters.entrySet().stream()
    .map(p -> urlEncodeUTF8(p.getKey()) + "=" + urlEncodeUTF8(p.getValue()))
    .reduce((p1, p2) -> p1 + "&" + p2)
    .orElse("");
于 2015-03-23T14:40:31.647 回答
23

在 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);
于 2014-08-14T02:42:35.267 回答
19

2016 年 6 月更新

感觉不得不添加一个答案,因为看到太多 SOF 答案,对非常常见的问题的答案过时或不充分 - 一个好的库和一些可靠的示例用法parseformat操作。

使用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(从名称-值对读取到查询字符串)查询字符串。但是,也有对 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
    }

这个库完全符合我的需要,并且能够替换一些被黑的自定义代码。

于 2016-06-10T08:55:38.300 回答
10

如果您确实想构建一个完整的 URI,请尝试Apache Http Compoments (HttpClient 4) 中的URIBuilder

这实际上并没有回答这个问题,但它回答了我发现这个问题时的问题。

于 2012-11-08T13:30:41.707 回答
10

我想使用 java 8 映射和减少来构建 @eclipse 的答案。

 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操作采用缩减后的字符串,并且?仅当字符串存在时才将 a 放在前面。

于 2017-06-30T22:07:58.950 回答
8

另一种“一个类”/无依赖的方式,处理单个/多个:

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);
    }
  }
}

您可以在需要时使用简单(在大多数情况下更容易编写)或多个。请注意,两者都可以通过添加&符号来组合......如果您发现任何问题,请在评论中告诉我。

于 2013-10-18T12:07:12.863 回答
6

这是我使用 Java 8 和org.apache.http.client.URLEncodedUtils. 它将映射的条目映射到列表中BasicNameValuePair,然后使用 ApacheURLEncodedUtils将其转换为查询字符串。

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

URLEncodedUtils.format(nameValuePairs, Charset.forName("UTF-8"));
于 2015-05-14T16:20:41.883 回答
4

java中没有内置任何东西可以做到这一点。但是,嘿,java 是一种编程语言,所以.. 让我们编程吧!

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

这给了你“param1=12¶m2=cat”。现在我们需要将 URL 和这个位连接在一起。你认为你可以这样做:URL + "?" + theAbove但如果 URL 已经包含一个问号,你必须用 "&" 代替它。一种检查方法是查看 URL 中是否已经存在问号。

另外,我不太清楚你的地图上有什么。如果它是原始的东西,您可能必须保护对e.getKey()e.getValue()URLEncoder.encode或类似的调用。

另一种方法是你有更广阔的视野。您是否尝试将地图的内容附加到 URL,或者...您是否尝试使用地图中的内容作为(附加)HTTP 参数从 Java 进程发出 HTTP(S) 请求?在后一种情况下,您可以查看像OkHttp这样的 http 库,它有一些很好的 API 可以完成这项工作,然后您可以放弃任何需要首先处理该 URL。

于 2019-06-19T12:52:23.267 回答
4

使用 EntrySet 和 Streams:

map
  .entrySet()
  .stream()
  .map(e -> e.getKey() + "=" + e.getValue())
  .collect(Collectors.joining("&"));
于 2019-06-19T13:25:17.060 回答
2

您可以Stream为此使用 a ,但我不会自己附加查询参数,而是使用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);
于 2019-06-19T13:45:12.563 回答
2

我认为这对内存使用和性能更好,我想在值为 null 时只发送属性名称。

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();
}
于 2019-10-05T06:57:15.117 回答
1

为了改进@eclipse的回答:在Javaland中,请求参数映射通常表示为 a Map<String, String[]>, aMap<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);
    }
}
于 2016-03-06T19:49:42.843 回答
0

就个人而言,我会寻求这样的解决方案,它与@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));
于 2019-06-19T13:03:35.043 回答
0

对于多值映射,您可以执行以下操作(使用 java 8 流 api)

网址编码已在此进行了处理。

MultiValueMap<String, String> params =  new LinkedMultiValueMap<>();
String urlQueryString = params.entrySet()
            .stream()
            .flatMap(stringListEntry -> stringListEntry.getValue()
                    .stream()
                    .map(s -> UriUtils.encode(stringListEntry.getKey(), StandardCharsets.UTF_8.toString()) + "=" +
                            UriUtils.encode(s, StandardCharsets.UTF_8.toString())))
            .collect(Collectors.joining("&"));
于 2020-07-25T19:05:43.453 回答
0

这是一个简单的 kotlin 解决方案:

fun Map<String, String>.toUrlParams(): String =
    entries.joinToString("&") {
        it.key.toUrlEncoded() + "=" + it.value.toUrlEncoded()
    }

fun String.toUrlEncoded(): String = URLEncoder.encode(
    this, StandardCharsets.UTF_8
)
于 2022-03-02T23:39:37.430 回答
-1

科特林

mapOf(
  "param1" to 12,
  "param2" to "cat"
).map { "${it.key}=${it.value}" }
  .joinToString("&")
于 2020-10-19T07:24:23.130 回答