Note that this method does not attempt to encode "=" and "&" + * characters in query parameter names and query parameter values because they cannot + * be parsed in a reliable way. Instead use: + *
+ * UriComponents uriComponents = UriComponentsBuilder.fromUri("/path?name={value}").buildAndExpand("a=b");
+ * String encodedUri = uriComponents.encode().toUriString();
+ *
* @param uri the URI to be encoded
* @param encoding the character encoding to encode to
* @return the encoded URI
* @throws IllegalArgumentException when the given uri parameter is not a valid URI
* @throws UnsupportedEncodingException when the given encoding parameter is not supported
+ * @deprecated in favor of {@link UriComponentsBuilder}; see note about query param encoding
*/
public static String encodeUri(String uri, String encoding) throws UnsupportedEncodingException {
- UriComponents uriComponents = UriComponentsBuilder.fromUriString(uri).build();
- UriComponents encoded = uriComponents.encode(encoding);
- return encoded.toUriString();
- }
+ Assert.notNull(uri, "'uri' must not be null");
+ Assert.hasLength(encoding, "'encoding' must not be empty");
+ Matcher m = URI_PATTERN.matcher(uri);
+ if (m.matches()) {
+ String scheme = m.group(2);
+ String authority = m.group(3);
+ String userinfo = m.group(5);
+ String host = m.group(6);
+ String port = m.group(8);
+ String path = m.group(9);
+ String query = m.group(11);
+ String fragment = m.group(13);
+
+ return encodeUriComponents(scheme, authority, userinfo, host, port, path, query, fragment, encoding);
+ }
+ else {
+ throw new IllegalArgumentException("[" + uri + "] is not a valid URI");
+ }
+ }
/**
* Encodes the given HTTP URI into an encoded String. All various URI components are
* encoded according to their respective valid character sets.
* Note that this method does not support fragments ({@code #}), * as these are not supposed to be sent to the server, but retained by the client. + *
Note that this method does not attempt to encode "=" and "&" + * characters in query parameter names and query parameter values because they cannot + * be parsed in a reliable way. Instead use: + *
+ * UriComponents uriComponents = UriComponentsBuilder.fromHttpUrl("/path?name={value}").buildAndExpand("a=b");
+ * String encodedUri = uriComponents.encode().toUriString();
+ *
* @param httpUrl the HTTP URL to be encoded
* @param encoding the character encoding to encode to
* @return the encoded URL
* @throws IllegalArgumentException when the given uri parameter is not a valid URI
* @throws UnsupportedEncodingException when the given encoding parameter is not supported
+ * @deprecated in favor of {@link UriComponentsBuilder}; see note about query param encoding
*/
public static String encodeHttpUrl(String httpUrl, String encoding) throws UnsupportedEncodingException {
- UriComponents uriComponents = UriComponentsBuilder.fromHttpUrl(httpUrl).build();
- UriComponents encoded = uriComponents.encode(encoding);
- return encoded.toUriString();
+ Assert.notNull(httpUrl, "'httpUrl' must not be null");
+ Assert.hasLength(encoding, "'encoding' must not be empty");
+ Matcher m = HTTP_URL_PATTERN.matcher(httpUrl);
+ if (m.matches()) {
+ String scheme = m.group(1);
+ String authority = m.group(2);
+ String userinfo = m.group(4);
+ String host = m.group(5);
+ String portString = m.group(7);
+ String path = m.group(8);
+ String query = m.group(10);
+
+ return encodeUriComponents(scheme, authority, userinfo, host, portString, path, query, null, encoding);
+ }
+ else {
+ throw new IllegalArgumentException("[" + httpUrl + "] is not a valid HTTP URL");
+ }
}
/**
@@ -87,20 +158,48 @@ public abstract class UriUtils {
* @return the encoded URI
* @throws IllegalArgumentException when the given uri parameter is not a valid URI
* @throws UnsupportedEncodingException when the given encoding parameter is not supported
+ * @deprecated in favor of {@link UriComponentsBuilder}
*/
public static String encodeUriComponents(String scheme, String authority, String userInfo,
String host, String port, String path, String query, String fragment, String encoding)
throws UnsupportedEncodingException {
- int portAsInt = (port != null ? Integer.parseInt(port) : -1);
+ Assert.hasLength(encoding, "'encoding' must not be empty");
+ StringBuilder sb = new StringBuilder();
- UriComponentsBuilder builder = UriComponentsBuilder.newInstance();
- builder.scheme(scheme).userInfo(userInfo).host(host).port(portAsInt);
- builder.path(path).query(query).fragment(fragment);
+ if (scheme != null) {
+ sb.append(encodeScheme(scheme, encoding));
+ sb.append(':');
+ }
- UriComponents encoded = builder.build().encode(encoding);
+ if (authority != null) {
+ sb.append("//");
+ if (userInfo != null) {
+ sb.append(encodeUserInfo(userInfo, encoding));
+ sb.append('@');
+ }
+ if (host != null) {
+ sb.append(encodeHost(host, encoding));
+ }
+ if (port != null) {
+ sb.append(':');
+ sb.append(encodePort(port, encoding));
+ }
+ }
- return encoded.toUriString();
+ sb.append(encodePath(path, encoding));
+
+ if (query != null) {
+ sb.append('?');
+ sb.append(encodeQuery(query, encoding));
+ }
+
+ if (fragment != null) {
+ sb.append('#');
+ sb.append(encodeFragment(fragment, encoding));
+ }
+
+ return sb.toString();
}
diff --git a/org.springframework.web/src/test/java/org/springframework/web/util/UriUtilsTests.java b/org.springframework.web/src/test/java/org/springframework/web/util/UriUtilsTests.java
index 4ccd215f140..444b7ec43c2 100644
--- a/org.springframework.web/src/test/java/org/springframework/web/util/UriUtilsTests.java
+++ b/org.springframework.web/src/test/java/org/springframework/web/util/UriUtilsTests.java
@@ -128,6 +128,9 @@ public class UriUtilsTests {
assertEquals("Invalid encoded URI", "http://example.com/query=foo@bar",
UriUtils.encodeUri("http://example.com/query=foo@bar", ENC));
+ // SPR-8974
+ assertEquals("http://example.org?format=json&url=http://another.com?foo=bar",
+ UriUtils.encodeUri("http://example.org?format=json&url=http://another.com?foo=bar", ENC));
}
@Test