UriTemplate: Insufficient handling of characters that need to be escaped. [SPR-6188]

[spring-projects-issues]

Sam Zurcher opened SPR-6188 and commented

The class UriTemplate (using the method expand(..)) has, according to my understanding, problems with URL parameters that contain e.g. German umlauts, or more general, characters that need to be escaped. E.g. the URL http://www.google.com/?q=zürich is not translated at all - which is ok because you could argue that it is the responsibility of the API user to escape the query parameter ('zürich') properly. BUT the URL http://www.google.com/?q=z%C3%BCrich is transformed into http://www.google.com/?q=z%25C3%25BCrich (= the percentage sign is encoded).

Attached you can find a unit test that describes the behavior in detail. Some of the tests fail describing my expectation.

---

Affects: 3.0 RC1

Attachments:

• UriTemplateTest.java (2.80 kB)

Referenced from: commits 60d2fdf

[spring-projects-issues]

Juergen Hoeller commented

Arjen, has this been addressed as part of the recent URI encoding revision already?

[spring-projects-issues]

Arjen Poutsma commented

This should be fixed now.

I've introduced our own encoding methods in UriUtils, since all those found in the JDK don't work (including URLDecoder and URI).

[spring-projects-issues]

Arjen Poutsma commented

Also, note that the RestTemplate takes unencoded URI strings as arguments. Thus, if you pass in a URI that's already encoded, it will be encoded again, as in your second example. The reason for this is quite simple: we cannot detect whether a given URI string is encoded or not.

If you don't want the additional encoding, I've added additional methods that takes java.net.URI as arguments. You can simply construct a URI using the UriTemplate, and reuse that.