有没有一种Java方法可以将参数集合编码为URL查询组件？

Question

是否有一个广泛使用的Java库，类似于dojo.objectToQuery()所做的事情？例如（假设使用HttpCore的HttpParams对象，但任何键值映射都可以）：

HttpParams params = new BasicHttpParams()
    .setParameter("foo", "bar")
    .setParameter("thud", "grunt");
UnknownLibrary.toQueryString(params);

应该会产生"foo=bar&thud=grunt"。

我知道这并不难写，但似乎应该已经有人写过了。我只是找不到它。

- Steven Huwig

---

事实证明，当我写下这个问题时，HttpParams并不像我想象的那样。 - Steven Huwig

Answer 1

为什么要重复造轮子？ Apache HttpClient 有 URLEncodedUtils：

   List<BasicNameValuePair> params = Arrays.asList(new BasicNameValuePair("\\%^ &=@#:", "\\%^ &=@#:"));
   String query = URLEncodedUtils.format(params, "UTF-8");

- user302163

Answer 2

我最终写了自己的代码。它可以像这样被调用：

URIUtils.withQuery(uri, "param1", "value1", "param2", "value2");

这并不是太糟糕。

/**
 * Concatenates <code>uri</code> with a query string generated from
 * <code>params</code>.
 *
 * @param uri the base URI
 * @param params a <code>Map</code> of key/value pairs
 * @return a new <code>URI</code>
 */

public static URI withQuery(URI uri, Map<String, String> params) {
    StringBuilder query = new StringBuilder();
    char separator = '?';
    for (Entry<String, String> param : params.entrySet()) {
        query.append(separator);
        separator = '&';
        try {
            query.append(URLEncoder.encode(param.getKey(), "UTF-8"));
            if (!StringUtils.isEmpty(param.getValue())) {
                query.append('=');
                query.append(URLEncoder.encode(param.getValue(), "UTF-8"));
            }
        } catch (UnsupportedEncodingException e) {
            throw new RuntimeException(e);
        }
    }
    return URI.create(uri.toString() + query.toString());
}

/**
 * Concatenates <code>uri</code> with a query string generated from
 * <code>params</code>.  The members of <code>params</code> will be
 * interpreted as {key1, val1, key2, val2}.  Empty values can be given
 * as <code>""</code> or <code>null</code>.
 *
 * @param uri the base URI
 * @param params the key/value pairs in sequence
 * @return a new <code>URI</code>
 */
public static URI withQuery(URI uri, String... params) {
    Map<String, String> map = new LinkedHashMap<String, String>();
    for (int i = 0; i < params.length; i += 2) {
        String key = params[i];
        String val = i + 1 < params.length ? params[i + 1] : "";
        map.put(key, val);
    }
    return withQuery(uri, map);
}

- Steven Huwig

Answer 3

你实际上不需要一个库来完成这个任务。我在HttpCore中也没有找到类似的库，所以我写了下面这样的代码：

public String toString() {

    StringBuilder sb = new StringBuilder(baseUrl);

    char separator;

    if (baseUrl.indexOf('?') > 0)
        separator = '&';
    else
        separator = '?';

    for (Parameter p : parameters) {
        sb.append(separator);
        try {
            sb.append(URLEncoder.encode(p.name, "UTF-8"));
            if (p.value != null) {
                sb.append('=');
                sb.append(URLEncoder.encode(p.value, "UTF-8"));
            }
        } catch (UnsupportedEncodingException e) {
            // Not really possible, throw unchecked exception
            throw new IllegalStateException("No UTF-8");
        }

        separator = '&';
    }

    return sb.toString();
}

- ZZ Coder

Answer 4

如果您使用JAX-RS，则可以使用javax.ws.rs.core.UriBuilder；除此之外，您应该主要了解URLEncoder和URLDecoder，它们至少会对参数列表的部分进行编码。

- Kathy Van Stone

Answer 5

有很多库可以帮助您构建URI（不要重复造轮子）。这是一个让您开始的库：

---

org.springframework:spring-web:4.2.5.RELEASE

import org.springframework.web.util.UriComponentsBuilder;
...
return UriComponentsBuilder.fromUriString(url).queryParam(key, value).build().toUri();

---

另请参阅：GIST > URI Builder Tests

- Nick Grealy

---

请不要发布重复答案 - 2 - 3 - 4。如果您认为问题是重复的，请标记为重复。 - Rob