UriComponentsBuilder should also contain subtractive methods [SPR-8803]

[spring-projects-issues]

Kenneth DeLong opened SPR-8803 and commented

UriComponentsBuilder should have methods also to subtract and remove items from the URI. For example, I might want to take the current URL and remove the pagination parameter from the URL:

UriComponentsBuilder.parse(request).removeParameter("page").build();

Also, I might want to change the UriPath

UriComponentsBuilder.parse(request).removeParameter("page").setUriPath("/new/path").build();

The advantage of this is we might want to keep the incoming request's DNS name, port, scheme, etc. This is a portable way of constructing URLs across environments (dev/qa/staging/prod).

URLs are not always used for redirecting etc. I might need to send out an email with a link to some page on the site. I could use the above functionality to construct a URL with the correct port, scheme, etc. in a simple portable fashion.

---

Affects: 3.1 RC1

Issue Links:

• Add ServletUriComponentsBuilder [SPR-8823] #13465 Add ServletUriComponentsBuilder

Referenced from: commits 2a39f34, d3f4c69

[spring-projects-issues]

Rossen Stoyanchev commented

Methods to replace the path and the query (or query params) have been added.

[spring-projects-issues]

Rossen Stoyanchev commented

A Servlet-variant of the UriComponentsBuilder will add options to create the UriComponentsBuilder from an HttpServletRequest. See #13465.

[spring-projects-issues]

Rossen Stoyanchev commented

Kenneth, the ServletUriComponentsBuilder is now available and should match more closely the example you gave above.

[spring-projects-issues]

Kenneth DeLong commented

ServletUriComponentsBuilder looks nice.

I didn't see removeParameter(), I saw replace() but that will leave the parameter name in the query string. It's often useful to remove it completely.

Thanks!!

[spring-projects-issues]

Rossen Stoyanchev commented

I've just updated replaceParameter(). If no values are provided, the parameter is removed.

[spring-projects-issues]

Kenneth DeLong commented

Looks great, thanks Rossen!