Query String Manipulation in Java

Question

Does anyone have, or know of, a java class that I can use to manipulate query strings?

Essentially I'd like a class that I can simply give a query string to and then delete, add and modify query string KVP's.

Thanks in advance.

EDIT

In response to a comment made to this question, the query string will look something like this;

N=123+456+112&Ntt=koala&D=abc

So I'd like to pass this class the query string and say something like;

String[] N = queryStringClass.getParameter("N");

and then maybe

queryStringClass.setParameter("N", N);

and maybe queryStringClass.removeParameter("N");

Or something to that effect.

You haven't provided enough context for anybody to give an answer. What kind of query strings? Please rephrase the question. — Jim Garrison
– Jim Garrison, Commented Nov 8, 2010 at 21:55

Maurizio Cucchiara · Accepted Answer · 2010-11-08 22:04:52Z

17

SOmething like this

 public static Map<String, String> getQueryMap(String query)  
 {  
     String[] params = query.split("&");  
     Map<String, String> map = new HashMap<String, String>();  
     for (String param : params)  
     {  
         String name = param.split("=")[0];  
         String value = param.split("=")[1];  
         map.put(name, value);  
     }  
     return map;  
 }

To iterate the map simply:

 String query = url.getQuery();  
 Map<String, String> map = getQueryMap(query);  
 Set<String> keys = map.keySet();  
 for (String key : keys)  
 {  
    System.out.println("Name=" + key);  
    System.out.println("Value=" + map.get(key));  
 }

answered Nov 8, 2010 at 22:04

Maurizio Cucchiara

8956 silver badges11 bronze badges

Sign up to request clarification or add additional context in comments.

4 Comments

griegs Over a year ago

Would love to have had something pre-built but this is great. :) thank you

LeastOne Over a year ago

It'd be more efficient to store param.split("=") in a variable and reusing the result as opposed to splitting the same param twice.

raulk Over a year ago

This solution does not take into account escaped characters.

Oliver Hausler Over a year ago

This solution also does not take into account arrays.

laughing_man · Accepted Answer · 2016-03-02 01:40:59Z

12

You can also use Google Guava's Splitter.

String queryString = "variableA=89&variableB=100";
Map<String,String> queryParameters = Splitter
    .on("&")
    .withKeyValueSeparator("=")
    .split(queryString);
System.out.println(queryParameters.get("variableA"));

prints out

This I think is a very readable alternative to parsing it yourself.

Edit: As @raulk pointed out, this solution does not account for escaped characters. However, this may not be an issue because before you URL-Decode, the query string is guaranteed to not have any escaped characters that conflict with '=' and '&'. You can use this to your advantage in the following way.

Say that you must decode the following query string:

a=%26%23%25!)%23(%40!&b=%23%24(%40)%24%40%40))%24%23%5E*%26

which is URL encoded, then you are guaranteed that the '&' and '=' are specifically used for separating pairs and key from value, respectively, at which point you can use the Guava splitter to get:

a = %26%23%25!)%23(%40!
b = %23%24(%40)%24%40%40))%24%23%5E*%26

Once you have obtained the key-value pairs, then you can URL decode them separately.

a = &#%!)#(@!
b = #$(@)$@@))$#^*&

That should cover all cases.

edited Mar 2, 2016 at 1:40

answered Aug 18, 2014 at 23:10

laughing_man

3,9981 gold badge22 silver badges22 bronze badges

2 Comments

raulk Over a year ago

This solution does not take into account escaped characters.

laughing_man Over a year ago

@raulk I've added some steps that could be used even with escaped characters. Thanks!

Avi · Accepted Answer · 2010-11-08 22:51:01Z

5

If you are using J2EE, you can use ServletRequest.getParameterValues().

Otherwise, I don't think Java has any common classes for query string handling. Writing your own shouldn't be too hard, though there are certain tricky edge cases, such as realizing that technically the same key may appear more than once in the query string.

One implementation might look like:

import java.util.*;
import java.net.URLEncoder;
import java.net.URLDecoder;

public class QueryParams {
private static class KVP {
    final String key;
    final String value;
    KVP (String key, String value) {
        this.key = key;
        this.value = value;
    }
}

List<KVP> query = new ArrayList<KVP>();

public QueryParams(String queryString) {
    parse(queryString);
}

public QueryParams() {
}

public void addParam(String key, String value) {
    if (key == null || value == null)
        throw new NullPointerException("null parameter key or value");
    query.add(new KVP(key, value));
}

private void parse(String queryString) {
    for (String pair : queryString.split("&")) {
        int eq = pair.indexOf("=");
        if (eq < 0) {
            // key with no value
            addParam(URLDecoder.decode(pair), "");
        } else {
            // key=value
            String key = URLDecoder.decode(pair.substring(0, eq));
            String value = URLDecoder.decode(pair.substring(eq + 1));
            query.add(new KVP(key, value));
        }
    }
}

public String toQueryString() {
    StringBuilder sb = new StringBuilder();
    for (KVP kvp : query) {
        if (sb.length() > 0) {
            sb.append('&');
        }
        sb.append(URLEncoder.encode(kvp.key));
        if (!kvp.value.equals("")) {
            sb.append('=');
            sb.append(URLEncoder.encode(kvp.value));
        }
    }
    return sb.toString();
}

public String getParameter(String key) {
    for (KVP kvp : query) {
        if (kvp.key.equals(key)) {
            return kvp.value;
        }
    }
    return null;
}

public List<String> getParameterValues(String key) {
    List<String> list = new LinkedList<String>();
    for (KVP kvp : query) {
        if (kvp.key.equals(key)) {
            list.add(kvp.value);
        }
    }
    return list;
}

public static void main(String[] args) {
    QueryParams qp = new QueryParams("k1=v1&k2&k3=v3&k1=v4&k1&k5=hello+%22world");
    System.out.println("getParameter:");
    String[] keys = new String[] { "k1", "k2", "k3", "k5" };
    for (String key : keys) {
        System.out.println(key + ": " + qp.getParameter(key));
    }
    System.out.println("getParameters(k1): " + qp.getParameterValues("k1"));
}
}

answered Nov 8, 2010 at 22:51

Avi

20.2k4 gold badges60 silver badges70 bronze badges

3 Comments

griegs Over a year ago

+1, thanks for this. Already implemented something like this.

Avi Over a year ago

@Achimnol: What's the problem? & is XML-encoding, it should pass through a URL parameter as %26amp;. If you want to further XML-decode the string, you can use other methods for that.

Vadzim Over a year ago

Note that ServletRequest.getParameterValues() can badly handle encoding: stackoverflow.com/questions/469874/…

matt burns · Accepted Answer · 2017-09-08 10:08:30Z

2

Another way is to use apache http-components. It's a bit hacky, but at least you leverage all the parsing corner cases:

List<NameValuePair> params = 
    URLEncodedUtils.parse("http://example.com/?" + queryString, Charset.forName("UTF-8"));

That'll give you a List of NameValuePair objects that should be easy to work with.

answered Sep 8, 2017 at 10:08

matt burns

25.6k13 gold badges112 silver badges110 bronze badges

1 Comment

AxelH Over a year ago

I found strange that this was not already proposed ... this is hacky but a good usage of an existing library...

CoolBeans · Accepted Answer · 2010-11-08 22:05:59Z

0

You can create a util method and use regular expression to parse it. A pattern like "[;&]" should suffice.

answered Nov 8, 2010 at 22:05

CoolBeans

20.9k10 gold badges88 silver badges102 bronze badges

Collectives™ on Stack Overflow

Query String Manipulation in Java

5 Answers 5

4 Comments

2 Comments

3 Comments

1 Comment

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

5 Answers 5

4 Comments

2 Comments

3 Comments

1 Comment

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related