fix #I78PB1

This commit is contained in:
Looly 2023-05-28 12:11:14 +08:00
parent 86ed9edb7f
commit 29e4937e8f
8 changed files with 134 additions and 58 deletions

View File

@ -24,6 +24,7 @@ import org.dromara.hutool.core.codec.PercentCodec;
public class RFC3986 { public class RFC3986 {
/** /**
* 通用URI组件分隔符<br>
* gen-delims = ":" / "/" / "?" / "#" / "[" / "]" / "@" * gen-delims = ":" / "/" / "?" / "#" / "[" / "]" / "@"
*/ */
public static final PercentCodec GEN_DELIMS = PercentCodec.Builder.of(":/?#[]@").build(); public static final PercentCodec GEN_DELIMS = PercentCodec.Builder.of(":/?#[]@").build();
@ -40,6 +41,7 @@ public class RFC3986 {
public static final PercentCodec RESERVED = PercentCodec.Builder.of(GEN_DELIMS).or(SUB_DELIMS).build(); public static final PercentCodec RESERVED = PercentCodec.Builder.of(GEN_DELIMS).or(SUB_DELIMS).build();
/** /**
* 非保留字符即URI中不作为分隔符使用的字符<br>
* unreserved = ALPHA / DIGIT / "-" / "." / "_" / "~"<br> * unreserved = ALPHA / DIGIT / "-" / "." / "_" / "~"<br>
* see: <a href="https://www.ietf.org/rfc/rfc3986.html#section-2.3">https://www.ietf.org/rfc/rfc3986.html#section-2.3</a> * see: <a href="https://www.ietf.org/rfc/rfc3986.html#section-2.3">https://www.ietf.org/rfc/rfc3986.html#section-2.3</a>
*/ */
@ -81,12 +83,26 @@ public class RFC3986 {
*/ */
public static final PercentCodec QUERY_PARAM_VALUE = PercentCodec.Builder.of(QUERY).removeSafe('&').build(); public static final PercentCodec QUERY_PARAM_VALUE = PercentCodec.Builder.of(QUERY).removeSafe('&').build();
/**
* query中的value编码器严格模式value中不能包含任何分隔符
*
* @since 6.0.0
*/
public static final PercentCodec QUERY_PARAM_VALUE_STRICT = UNRESERVED;
/** /**
* query中的key<br> * query中的key<br>
* key不能包含"{@code &}" "=" * key不能包含"{@code &}" "="
*/ */
public static final PercentCodec QUERY_PARAM_NAME = PercentCodec.Builder.of(QUERY_PARAM_VALUE).removeSafe('=').build(); public static final PercentCodec QUERY_PARAM_NAME = PercentCodec.Builder.of(QUERY_PARAM_VALUE).removeSafe('=').build();
/**
* query中的key编码器严格模式key中不能包含任何分隔符
*
* @since 6.0.0
*/
public static final PercentCodec QUERY_PARAM_NAME_STRICT = UNRESERVED;
/** /**
* unreserved = ALPHA / DIGIT / "-" / "." / "_" / "~" * unreserved = ALPHA / DIGIT / "-" / "." / "_" / "~"
* *

View File

@ -434,7 +434,7 @@ public final class UrlBuilder implements Builder<String> {
} }
/** /**
* 添加查询项支持重复键 * 添加查询项支持重复键默认非严格模式
* *
* @param key * @param key
* @param value * @param value
@ -446,7 +446,7 @@ public final class UrlBuilder implements Builder<String> {
} }
if (this.query == null) { if (this.query == null) {
this.query = new UrlQuery(); this.query = UrlQuery.of();
} }
this.query.add(key, value); this.query.add(key, value);
return this; return this;

View File

@ -42,6 +42,31 @@ public class UrlQuery {
* 是否为x-www-form-urlencoded模式此模式下空格会编码为'+' * 是否为x-www-form-urlencoded模式此模式下空格会编码为'+'
*/ */
private final boolean isFormUrlEncoded; private final boolean isFormUrlEncoded;
/**
* 是否严格模式严格模式下query的name和value中均不允许有分隔符
*/
private final boolean isStrict;
// region ----- of
/**
* 构建UrlQuery
*
* @return UrlQuery
*/
public static UrlQuery of() {
return of(false, false);
}
/**
* 构建UrlQuery
*
* @param isFormUrlEncoded 是否为x-www-form-urlencoded模式此模式下空格会编码为'+'
* @param isStrict 是否严格模式严格模式下query的name和value中均不允许有分隔符
* @return UrlQuery
*/
public static UrlQuery of(final boolean isFormUrlEncoded, final boolean isStrict) {
return new UrlQuery(null, isFormUrlEncoded, isStrict);
}
/** /**
* 构建UrlQuery * 构建UrlQuery
@ -50,7 +75,7 @@ public class UrlQuery {
* @return UrlQuery * @return UrlQuery
*/ */
public static UrlQuery of(final Map<? extends CharSequence, ?> queryMap) { public static UrlQuery of(final Map<? extends CharSequence, ?> queryMap) {
return new UrlQuery(queryMap); return of(queryMap, false, false);
} }
/** /**
@ -58,10 +83,11 @@ public class UrlQuery {
* *
* @param queryMap 初始化的查询键值对 * @param queryMap 初始化的查询键值对
* @param isFormUrlEncoded 是否为x-www-form-urlencoded模式此模式下空格会编码为'+' * @param isFormUrlEncoded 是否为x-www-form-urlencoded模式此模式下空格会编码为'+'
* @param isStrict 是否严格模式严格模式下query的name和value中均不允许有分隔符
* @return UrlQuery * @return UrlQuery
*/ */
public static UrlQuery of(final Map<? extends CharSequence, ?> queryMap, final boolean isFormUrlEncoded) { public static UrlQuery of(final Map<? extends CharSequence, ?> queryMap, final boolean isFormUrlEncoded, final boolean isStrict) {
return new UrlQuery(queryMap, isFormUrlEncoded); return new UrlQuery(queryMap, isFormUrlEncoded, isStrict);
} }
/** /**
@ -85,7 +111,7 @@ public class UrlQuery {
* @since 5.5.8 * @since 5.5.8
*/ */
public static UrlQuery of(final String queryStr, final Charset charset, final boolean autoRemovePath) { public static UrlQuery of(final String queryStr, final Charset charset, final boolean autoRemovePath) {
return of(queryStr, charset, autoRemovePath, false); return of(queryStr, charset, autoRemovePath, false, false);
} }
/** /**
@ -95,47 +121,24 @@ public class UrlQuery {
* @param charset decode用的编码null表示不做decode * @param charset decode用的编码null表示不做decode
* @param autoRemovePath 是否自动去除path部分{@code true}则自动去除第一个?前的内容 * @param autoRemovePath 是否自动去除path部分{@code true}则自动去除第一个?前的内容
* @param isFormUrlEncoded 是否为x-www-form-urlencoded模式此模式下空格会编码为'+' * @param isFormUrlEncoded 是否为x-www-form-urlencoded模式此模式下空格会编码为'+'
* @param isStrict 是否严格模式严格模式下query的name和value中均不允许有分隔符
* @return UrlQuery * @return UrlQuery
* @since 5.7.16 * @since 5.7.16
*/ */
public static UrlQuery of(final String queryStr, final Charset charset, final boolean autoRemovePath, final boolean isFormUrlEncoded) { public static UrlQuery of(final String queryStr, final Charset charset, final boolean autoRemovePath
return new UrlQuery(isFormUrlEncoded).parse(queryStr, charset, autoRemovePath); , final boolean isFormUrlEncoded, final boolean isStrict) {
} return new UrlQuery(null, isFormUrlEncoded, isStrict).parse(queryStr, charset, autoRemovePath);
/**
* 构造
*/
public UrlQuery() {
this(null);
}
/**
* 构造
*
* @param isFormUrlEncoded 是否为x-www-form-urlencoded模式此模式下空格会编码为'+'
* @since 5.7.16
*/
public UrlQuery(final boolean isFormUrlEncoded) {
this(null, isFormUrlEncoded);
}
/**
* 构造
*
* @param queryMap 初始化的查询键值对
*/
public UrlQuery(final Map<? extends CharSequence, ?> queryMap) {
this(queryMap, false);
} }
// endregion
/** /**
* 构造 * 构造
* *
* @param queryMap 初始化的查询键值对 * @param queryMap 初始化的查询键值对
* @param isFormUrlEncoded 是否为x-www-form-urlencoded模式此模式下空格会编码为'+' * @param isFormUrlEncoded 是否为x-www-form-urlencoded模式此模式下空格会编码为'+'
* @since 5.7.16 * @param isStrict 是否严格模式严格模式下query的name和value中均不允许有分隔符
*/ */
public UrlQuery(final Map<? extends CharSequence, ?> queryMap, final boolean isFormUrlEncoded) { public UrlQuery(final Map<? extends CharSequence, ?> queryMap, final boolean isFormUrlEncoded, final boolean isStrict) {
if (MapUtil.isNotEmpty(queryMap)) { if (MapUtil.isNotEmpty(queryMap)) {
query = new TableMap<>(queryMap.size()); query = new TableMap<>(queryMap.size());
addAll(queryMap); addAll(queryMap);
@ -143,6 +146,7 @@ public class UrlQuery {
query = new TableMap<>(MapUtil.DEFAULT_INITIAL_CAPACITY); query = new TableMap<>(MapUtil.DEFAULT_INITIAL_CAPACITY);
} }
this.isFormUrlEncoded = isFormUrlEncoded; this.isFormUrlEncoded = isFormUrlEncoded;
this.isStrict = isStrict;
} }
/** /**
@ -263,6 +267,9 @@ public class UrlQuery {
return build(FormUrlencoded.ALL, FormUrlencoded.ALL, charset, encodePercent); return build(FormUrlencoded.ALL, FormUrlencoded.ALL, charset, encodePercent);
} }
if(isStrict){
return build(RFC3986.QUERY_PARAM_NAME_STRICT, RFC3986.QUERY_PARAM_VALUE_STRICT, charset, encodePercent);
}
return build(RFC3986.QUERY_PARAM_NAME, RFC3986.QUERY_PARAM_VALUE, charset, encodePercent); return build(RFC3986.QUERY_PARAM_NAME, RFC3986.QUERY_PARAM_VALUE, charset, encodePercent);
} }

View File

@ -77,7 +77,7 @@ public class UrlQueryUtil {
* @since 5.7.16 * @since 5.7.16
*/ */
public static String toQuery(final Map<String, ?> paramMap, final Charset charset, final boolean isFormUrlEncoded) { public static String toQuery(final Map<String, ?> paramMap, final Charset charset, final boolean isFormUrlEncoded) {
return UrlQuery.of(paramMap, isFormUrlEncoded).build(charset); return UrlQuery.of(paramMap, isFormUrlEncoded, false).build(charset);
} }
/** /**

View File

@ -1,11 +1,15 @@
package org.dromara.hutool.core.net; package org.dromara.hutool.core.net;
import org.dromara.hutool.core.lang.Console;
import org.dromara.hutool.core.net.url.URLDecoder; import org.dromara.hutool.core.net.url.URLDecoder;
import org.dromara.hutool.core.net.url.URLEncoder; import org.dromara.hutool.core.net.url.URLEncoder;
import org.dromara.hutool.core.net.url.UrlQuery;
import org.dromara.hutool.core.util.CharsetUtil;
import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.Test; import org.junit.jupiter.api.Test;
public class URLEncoderTest { public class URLEncoderTest {
@Test @Test
void encodeTest() { void encodeTest() {
final String body = "366466 - 副本.jpg"; final String body = "366466 - 副本.jpg";

View File

@ -19,7 +19,7 @@ public class UrlQueryTest {
@Test @Test
public void parseTest() { public void parseTest() {
final String queryStr = "a=1&b=111=="; final String queryStr = "a=1&b=111==";
final UrlQuery q = new UrlQuery(); final UrlQuery q = UrlQuery.of();
final UrlQuery parse = q.parse(queryStr, Charset.defaultCharset()); final UrlQuery parse = q.parse(queryStr, Charset.defaultCharset());
Assertions.assertEquals("111==", parse.get("b")); Assertions.assertEquals("111==", parse.get("b"));
Assertions.assertEquals("a=1&b=111==", parse.toString()); Assertions.assertEquals("a=1&b=111==", parse.toString());
@ -37,7 +37,7 @@ public class UrlQueryTest {
@Test @Test
public void parseTest2() { public void parseTest2() {
final String requestUrl = "http://192.168.1.1:8080/pc?=d52i5837i4ed=o39-ap9e19s5--=72e54*ll0lodl-f338868d2"; final String requestUrl = "http://192.168.1.1:8080/pc?=d52i5837i4ed=o39-ap9e19s5--=72e54*ll0lodl-f338868d2";
final UrlQuery q = new UrlQuery(); final UrlQuery q = UrlQuery.of();
final UrlQuery parse = q.parse(requestUrl, Charset.defaultCharset()); final UrlQuery parse = q.parse(requestUrl, Charset.defaultCharset());
Assertions.assertEquals("=d52i5837i4ed=o39-ap9e19s5--=72e54*ll0lodl-f338868d2", parse.toString()); Assertions.assertEquals("=d52i5837i4ed=o39-ap9e19s5--=72e54*ll0lodl-f338868d2", parse.toString());
} }
@ -144,4 +144,15 @@ public class UrlQueryTest {
final UrlQuery query = UrlQuery.of(queryStr, null); final UrlQuery query = UrlQuery.of(queryStr, null);
Assertions.assertEquals(queryStr, query.toString()); Assertions.assertEquals(queryStr, query.toString());
} }
@Test
void issueI78PB1Test() {
// 严格模式
final UrlQuery query = UrlQuery.of(false, true);
query.add(":/?#[]@!$&'()*+,;= ", ":/?#[]@!$&'()*+,;= ");
final String string = query.build(CharsetUtil.UTF_8);
Assertions.assertEquals("%3A%2F%3F%23%5B%5D%40%21%24%26%27%28%29%2A%2B%2C%3B%3D%20=" +
"%3A%2F%3F%23%5B%5D%40%21%24%26%27%28%29%2A%2B%2C%3B%3D%20", string);
}
} }

View File

@ -52,7 +52,7 @@ public class UrlEncodedFormBody extends FormBody<UrlEncodedFormBody> {
@Override @Override
public void write(final OutputStream out) { public void write(final OutputStream out) {
final byte[] bytes = ByteUtil.toBytes(UrlQuery.of(form, true).build(charset), charset); final byte[] bytes = ByteUtil.toBytes(UrlQuery.of(form, true, false).build(charset), charset);
IoUtil.write(out, false, bytes); IoUtil.write(out, false, bytes);
} }

View File

@ -0,0 +1,38 @@
/*
* Copyright (c) 2023 looly(loolly@aliyun.com)
* Hutool is licensed under Mulan PSL v2.
* You can use this software according to the terms and conditions of the Mulan PSL v2.
* You may obtain a copy of Mulan PSL v2 at:
* http://license.coscl.org.cn/MulanPSL2
* THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND,
* EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT,
* MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
* See the Mulan PSL v2 for more details.
*/
package org.dromara.hutool.http;
import org.apache.hc.core5.net.URIBuilder;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.Test;
import java.net.URISyntaxException;
public class IssueI78PB1Test {
/**
* 参考HttpClient对RFC396规范的理解query中对于分隔符作为内容时理应编码
*
* @throws URISyntaxException 异常
*/
@Test
void uriBuilderTest() throws URISyntaxException {
final URIBuilder ub = new URIBuilder("https://hutool.cn");
ub.setPath("/ /");
ub.addParameter(":/?#[]@!$&'()*+,;= ", ":/?#[]@!$&'()*+,;= ");
final String url = ub.toString();
Assertions.assertEquals("https://hutool.cn/%20/?" +
"%3A%2F%3F%23%5B%5D%40%21%24%26%27%28%29%2A%2B%2C%3B%3D%20=" +
"%3A%2F%3F%23%5B%5D%40%21%24%26%27%28%29%2A%2B%2C%3B%3D%20", url);
}
}