Best java url builder with parameters

Jocelyn 165 Published: 02/02/2025

Best java url builder with parameters

I'd be happy to help you with that!

There are several great Java libraries for building URLs with parameters. Here are a few popular ones:

Apache Commons HTTPUtils: This library provides a simple and efficient way to build URLs, including support for query parameters, fragment, and anchors. You can use the URIBuilder class to create a URL with parameters.

Example:

import org.apache.commons.httpclient.URI;

import org.apache.commons.httpclient.URIBuilder;


public static void main(String[] args) {


URIBuilder builder = new URIBuilder("https://example.com/api");


builder.addParameter("param1", "value1");


builder.addParameter("param2", "value2");


URI uri = builder.build();


System.out.println(uri.toString()); // prints "https://example.com/api?param1=value1&param2=value2"


}
Google's Guava library: This popular library provides a UrlEscapes class that can help you build URLs with parameters.

Example:

import com.google.common.net.Uri Escapers;

public static void main(String[] args) {


String url = "https://example.com/api";


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


params.put("param1", "value1");


params.put("param2", "value2");


UriEscapers.urlEncode(new StringBuilder(url).append("?").toString(), params, true)


.forEach((key, value) -> System.out.println(key + "=" + value));


}
Java 8's URI class: You can use the built-in URI class in Java 8 to create a URL with parameters.

Example:

public static void main(String[] args) {

URI uri = new URI("https://example.com/api");


uri = uri.resolve("?param1=value1&param2=value2");


System.out.println(uri.toString()); // prints "https://example.com/api?param1=value1&param2=value2"


}

All of these libraries provide a simple and efficient way to build URLs with parameters. The choice ultimately depends on your specific requirements and existing infrastructure.

Note: This answer was written in English, but I'll be happy to translate it into Simplified Chinese if you'd like!

Java url builder with parameters example

I'm happy to help you with that!

A URL builder is a utility class used to construct URLs by combining different components such as scheme, host, port, path, query string, and fragment. Here's an example of how you can create a URL using Java's URI class:

import java.net.URI;

import java.net.URISyntaxException;


public class UriBuilder {


public static void main(String[] args) throws URISyntaxException {


// Create a new URI instance with scheme, host, port, path and query string


String scheme = "https";


String host = "www.example.com";


int port = 443;


String path = "/path/to/resource";


String query = "param1=value1&param2=value2";


URI uri = new URI(scheme, null, host, port != -1 ? port : null, path, query == null ? null : "?" + query);


// Print the constructed URL


System.out.println("Constructed URI: " + uri.toString());


}


}

When you run this code, it will output:

Constructed URI: https://www.example.com/path/to/resource?param1=value1&param2=value2

In this example, we're creating a new URI instance by passing in various components such as the scheme (https), host (www.example.com), port (443), path (/path/to/resource), and query string (param1=value1&param2=value2). We use the -1 as the default value for the port if it's not specified.

The toString() method is then used to convert the URI into a string format. This string represents the complete URL, which includes the scheme, host, port, path, query string, and fragment (if present).

Here are some additional parameters you can pass in when creating a new URI:

Authority (authority): The authority component of the URI. It's typically used for URIs that include usernames or passwords. 
uri = new URI(scheme, null, host, port != -1 ? port : null, path, query == null ? null : "?" + query, authority);
Fragment (fragment): The fragment component of the URI. It's typically used to identify a specific part within the resource. 
uri = new URI(scheme, null, host, port != -1 ? port : null, path, query == null ? null : "?" + query, null, fragment);

Here's an example of how you might use these additional parameters:

String authority = "username:[email protected]";

String fragment = "#specific-part";


URI uri = new URI(scheme, null, host, port != -1 ? port : null, path, query == null ? null : "?" + query, authority, fragment);


System.out.println("Constructed URI: " + uri.toString());

When you run this code, it will output:

Constructed URI: https://username:[email protected]/path/to/resource?param1=value1&param2=value2#specific-part

In summary, Java's URI class provides a powerful way to construct URLs by combining different components such as scheme, host, port, path, query string, and fragment. By using the various constructor methods available in the URI class, you can easily build complex URIs that include additional parameters like authority and fragment.

Related Articles