UriBuilder encoding issue with queryParam

Question

var responseEntity =
          webClient
              .get()
              .uri(
                  uriBuilder ->
                      uriBuilder
                          .path("myendpoint")
                          .queryParam("email", email)
                          .build())
              .retrieve()

The problem with this code is that if the email here is like [email protected], the URI default encoding doesn't encode + in the queryParam, and if I myself encode the string to Proper Uri encoded string: like: my%[email protected], in this case, URI default encoder here will encode the % symbol as well. Now, if I use the .encode() function of uriBuilder, it would also encode @ in the email.

I want to achieve URI like: https://myendpoint?email=my%[email protected]

Can somebody please help with this? Thanks a lot.

Kartik Arora · Accepted Answer · 2023-03-08 12:00:02Z

3

The param within build(boolean encoded) function of UriComponentsBuilder actually define if a URI is already encoded and prevent double encoding of the params again, so we can pass an encoded email to the param and prevent any encoding to be run on that email through the uriBuilder itself.

 var responseEntity =
          webClient
              .get()
              .uri(
                  uriBuilder ->
                      UriComponentsBuilder.fromUri(uriBuilder.build())
                          .path("myendpoint")
                          .queryParam("email", getEncodedEmail(email))
                          .build(true)
                          .toUri())
              .retrieve();

private String getEncodedEmail(String email){
    return URLEncoder.encode(email, StandardCharsets.UTF_8).replace("%40","@");
  }

answered Mar 8, 2023 at 12:00

Kartik Arora

1,1751 gold badge12 silver badges18 bronze badges

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

Comments

MarcelMM · Accepted Answer · 2023-03-08 05:12:27Z

0

You can instanciate the URI this way:

URI.create("myendpoint?email=" + URLEncoder.encode("[email protected]", StandardCharsets.UTF_8).replace("%40", "@"))

It's not very elegant but it works.

edited Mar 8, 2023 at 5:12

answered Mar 8, 2023 at 4:56

MarcelMM

2021 silver badge5 bronze badges

3 Comments

Kartik Arora Over a year ago

Hi, thanks for your answer, I had such implementation while trying some workarounds: java URI uri = factory.uriString("myendpoint").queryParam("email", "{email}").build(email); Another problem here is though, my actual domain address won't come, it would only have the endpoint, but the actual URL should be: mydomain/myendpoint?email, and I don't want to hardcode mydomain, Is there some efficient way to achieve that?

MarcelMM Over a year ago

I don't know if I understood correctly. But if the endpoint is not hardcoded, where is it going to be? Maybe you need to receive it as a parameter or use some strategy using ThreadLocal. Then put it all together with a StringBuilder.

Kartik Arora Over a year ago

I have been able to solve the issue in a cleaner way, making use of the encoded param within the build function of UriComponentsBuilderf as i would be adding as an answer.

Collectives™ on Stack Overflow

UriBuilder encoding issue with queryParam

2 Answers 2

Comments

3 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

3 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related